Consumer Groups Examples

    For example, you could define three consumer groups:

    • A “gold tier” with 1000 requests per minute
    • A “silver tier” with 10 requests per second
    • A “bronze tier” with 6 requests per second

    The endpoint works together with the .

    Consumers that are not in a consumer group default to the Rate Limiting advanced plugin’s configuration, so you can define tier groups for some users and have a default behavior for consumers without groups.

    To use consumer groups for rate limiting, you need to:

    • Create one or more consumer groups
    • Create consumers
    • Assign consumers to groups
    • Configure the Rate Limiting Advanced plugin with the enforce_consumer_groups and consumer_groups parameters, setting up the list of consumer groups that the plugin accepts
    • Configure rate limiting for each consumer group, overriding the plugin’s configuration

    For all possible requests, see the Consumer Groups reference.

    1. Create a consumer group named JL:

      cURL

      HTTPie

      1. http POST :8001/consumer_groups name=JL

      Response:

      1.  {
      2.      "created_at": 1638915521,
      3.      "id": "8a4bba3c-7f82-45f0-8121-ed4d2847c4a4",
      4.      "name": "JL"
      5.  }

    2. Create a consumer, DianaPrince:

      cURL

      HTTPie

      1. curl -i -X POST http://{HOSTNAME}:8001/consumers \
      2.    --data username=DianaPrince
      1. http POST :8001/consumers username=DianaPrince

      Response:

      1.  {
      2.      "created_at": 1638915577,
      3.      "custom_id": null,
      4.      "id": "8089a0e6-1d31-4e00-bf51-5b902899b4cb",
      5.      "tags": null,
      6.      "type": 0,
      7.      "username": "DianaPrince",
      8.      "username_lower": "dianaprince"
      9.  }

    3. Add DianaPrince to the JL consumer group:

      cURL

      HTTPie

      1. curl -i -X POST http://{HOSTNAME}:8001/consumer_groups/JL/consumers \
      2.    --data consumer=DianaPrince
      1. http POST :8001/consumer_groups/JL/consumers consumer=DianaPrince

      Response:

      1.  {
      2.    "consumer_group": {
      3.    "created_at": 1638915521,
      4.    "id": "8a4bba3c-7f82-45f0-8121-ed4d2847c4a4",
      5.    "name": "JL"
      6.    },
      7.    "consumers": [
      8.      {
      9.          "created_at": 1638915577,
      10.          "id": "8089a0e6-1d31-4e00-bf51-5b902899b4cb",
      11.          "type": 0,
      12.          "username": "DianaPrince",
      13.          "username_lower": "dianaprince"
      14.      }
      15.    ]
      16.  }

    Set up Rate Limiting Advanced config for consumer group

    1. Enable the , setting the rate limit to five requests (config.limit) for every 30 seconds (config.window_size):

      cURL

      HTTPie

      1. curl -i -X POST http://{HOSTNAME}:8001/plugins/  \
      2.    --data name=rate-limiting-advanced \
      3.    --data config.limit=5 \
      4.    --data config.window_size=30 \
      5.    --data config.window_type=sliding \
      6.    --data config.retry_after_jitter_max=0 \
      7.    --data config.enforce_consumer_groups=true \
      8.    --data config.consumer_groups=JL
      1. http -f :8001/plugins/  \
      2.    name=rate-limiting-advanced \
      3.    config.limit=5 \
      4.    config.window_size=30 \
      5.    config.window_type=sliding \
      6.    config.retry_after_jitter_max=0 \
      7.    config.enforce_consumer_groups=true \
      8.    config.consumer_groups=JL

      For consumer groups, the following parameters are required:

      • config.enforce_consumer_groups=true: enables consumer groups for this plugin.
      • config.consumer_groups=JL: specifies a list of groups that this plugin allows overrides for.

      Note: In this example, you’re configuring the plugin globally, so it applies to all entities (Services, Routes, and Consumers) in the Kong Gateway instance. You can also apply it to a specific Service or Route for more granular control.

    2. The plugin you just set up applies to all consumers in the cluster. Change the rate limiting configuration for the JL consumer group only, setting the limit to ten requests for every ten seconds:

      cURL

      HTTPie

      1. curl -i -X PUT http://{HOSTNAME}:8001/consumer_groups/JL/overrides/plugins/rate-limiting-advanced \
      2.    --data config.limit=10 \
      3.    --data config.window_size=10 \
      4.    --data config.retry_after_jitter_max=1
      1. http PUT :8001/consumer_groups/JL/overrides/plugins/rate-limiting-advanced \
      2.    config.limit=10 \
      3.    config.window_size=10 \
      4.    config.retry_after_jitter_max=1

      Response:

      1.  {
      2.    "config": {
      3.        "limit": [
      4.            10
      5.        ],
      6.        "retry_after_jitter_max": 1,
      7.        "window_size": [
      8.            10
      9.        ]
      10.    "consumer_group": "JL",
      11.    "plugin": "rate-limiting-advanced"
      12.  }

    3. Check that it worked by looking at the JL consumer group object:

      cURL

      HTTPie

      1. curl -i -X GET http://{HOSTNAME}:8001/consumer_groups/JL
      1. http :8001/consumer_groups/JL

      Notice the plugins object in the response, along with the parameters that you just set for the Rate Limiting Advanced plugin:

      2.      "consumer_group": {
      3.          "created_at": 1638915521,
      4.          "id": "8a4bba3c-7f82-45f0-8121-ed4d2847c4a4",
      5.          "name": "JL"
      6.      },
      7.      "consumers": [
      8.          {
      9.              "created_at": 1638915577,
      10.              "id": "8089a0e6-1d31-4e00-bf51-5b902899b4cb",
      11.              "type": 0,
      12.              "username": "DianaPrince",
      13.              "username_lower": "dianaprince"
      14.          }
      15.      ],
      16.      "plugins": [
      17.          {
      18.              "config": {
      19.                  "limit": [
      20.                      10
      21.                  ],
      22.                  "retry_after_jitter_max": 1,
      23.                  "window_size": [
      24.                      10
      25.                  ],
      26.                  "window_type": "sliding"
      27.              },
      28.              "consumer_group": {
      29.                  "id": "8a4bba3c-7f82-45f0-8121-ed4d2847c4a4"
      30.              },
      31.              "created_at": 1638916518,
      32.              "id": "b7c426a2-6fcc-4bfd-9b7a-b66e8f1ad260",
      33.              "name": "rate-limiting-advanced"
      34.          }
      35.      ]
      36.  }

    1. Check the JL consumer group for the consumer name:

      cURL

      HTTPie

      1. curl -i -X GET http://{HOSTNAME}:8001/consumer_groups/JL
      1. http :8001/consumer_groups/JL

      Response:

    2. Using the username or ID of the consumer (DianaPrince in this example), remove the consumer from the group:

      cURL

      HTTPie

      1. curl -i -X DELETE http://{HOSTNAME}:8001/consumer_groups/JL/consumers/DianaPrince
      1. http DELETE :8001/consumer_groups/JL/consumers/DianaPrince

      If successful, you receive the following response:

      1.  HTTP/1.1 204 No Content

    3. To verify, check the consumer group configuration again:

      cURL

      HTTPie

      1. curl -i -X GET http://{HOSTNAME}:8001/consumer_groups/JL
      1. http :8001/consumer_groups/JL

      Response, with no consumers assigned:

      1.  {
      2.      "consumer_group": {
      3.          "created_at": 1638917780,
      4.          "id": "be4bcfca-b1df-4fac-83cc-5cf6774bf48e",
      5.          "name": "JL"
      6.      }
      7.  }

    Remove consumer from group - consumer view

    You can remove a consumer from a group by accessing /consumers or /consumer_groups. The following steps use /consumers.

    1. If you know the consumer name and not the consumer group name, you can look up the group through the consumer:

      cURL

      HTTPie

      1. curl -i -X GET http://{HOSTNAME}:8001/consumers/DianaPrince/consumer_groups
      1. http :8001/consumers/DianaPrince/consumer_groups

      Response:

      1.  {
      2.      "consumer_groups": [
      3.          {
      4.              "created_at": 1638915521,
      5.              "id": "8a4bba3c-7f82-45f0-8121-ed4d2847c4a4",
      6.              "name": "JL"
      7.          }
      8.      ]
      9.  }

    2. Using the username or ID of the group (JL in this example), remove the consumer from the group:

      cURL

      HTTPie

      1. curl -i -X DELETE http://{HOSTNAME}:8001/consumers/DianaPrince/consumer_groups/JL
      1. http DELETE :8001/consumers/DianaPrince/consumer_groups/JL

      If successful, you receive the following response:

      1.  HTTP/1.1 204 No Content

    3. To verify, check the consumer object configuration:

      cURL

      HTTPie

      1. curl -i -X GET http://{HOSTNAME}:8001/consumer_groups/JL
      1. http :8001/consumer_groups/JL

      Response, with no consumers assigned:

      1.  {
      2.      "consumer_group": {
      3.          "created_at": 1638917780,
      4.          "id": "be4bcfca-b1df-4fac-83cc-5cf6774bf48e",
      5.          "name": "JL"
      6.      }
      7.  }

    If you don’t need a consumer group anymore, you can delete it. This removes all consumers from the group, and deletes the group itself. The consumers in the group are not deleted.

    1. Delete a consumer group using the following request:

      cURL

      HTTPie

      1. curl -i -X DELETE http://{HOSTNAME}:8001/consumer_groups/JL
      1. http DELETE :8001/consumer_groups/JL

      If successful, you receive see the following response:

      1.  HTTP/1.1 204 No Content

    2. Check the list of consumer groups to verify that the JL group is gone:

      HTTPie

      1. http :8001/consumer_groups

      Response:

      1.  "data": [],
      2.  "next": null

    3. Check a consumer that was in the group to make sure it still exists:

      cURL

      HTTPie

      1. curl -i -X GET http://{HOSTNAME}:8001/consumers/DianaPrince
      1. http :8001/consumers/DianaPrince

      An HTTP/1.1 200 OK response means the consumer exists.

    Manage multiple consumers

    You can perform many /consumer_groups operations in bulk.

    1. Assuming you deleted the group JL in the previous section, create it again, along with another group named Speedsters:

      cURL

      HTTPie

      1. curl -i -X POST http://{HOSTNAME}:8001/consumer_groups \
      2.    --data name=JL
      4.  curl -i -X POST http://{HOSTNAME}:8001/consumer_groups \
      5.    --data name=Speedsters
      1. http POST :8001/consumer_groups name=JL
      3.  http POST :8001/consumer_groups name=Speedsters

    2. Create two consumers, BarryAllen and WallyWest:

      cURL

      HTTPie

      1. curl -i -X POST http://{HOSTNAME}:8001/consumers \
      2.    --data username=BarryAllen
      4.  curl -i -X POST http://{HOSTNAME}:8001/consumers \
      5.    --data username=WallyWest
      1. http POST :8001/consumers username=BarryAllen
      3.  http POST :8001/consumers username=WallyWest

    3. Add both consumers to the Speedsters group:

      cURL

      HTTPie

      1. curl -i -X POST http://{HOSTNAME}:8001/consumer_groups/Speedsters/consumers \
      2.    --data consumer=BarryAllen \
      3.    --data consumer=WallyWest
      1. http POST :8001/consumer_groups/Speedsters/consumers \
      2.    consumer:='["BarryAllen", "WallyWest"]'

      Kong Gateway validates the provided list of consumers before assigning them to the consumer group. To pass validation, consumers must exist and must not be in the group already.

      If any consumer fails validation, no consumers are assigned to the group.

      Response, if everything is successful:

      1.  {
      2.      "consumer_group": {
      3.          "created_at": 1639432267,
      4.          "id": "a905151a-5767-40e8-804e-50eec4d0235b",
      5.          "name": "Speedsters"
      6.      },
      7.      "consumers": [
      8.          {
      9.              "created_at": 1639432286,
      10.              "id": "ea904e1d-1f0d-4d5a-8391-cae60cb21d61",
      11.              "type": 0,
      12.              "username": "BarryAllen",
      13.              "username_lower": "barryallen"
      14.          },
      15.          {
      16.              "created_at": 1639432288,
      17.              "id": "065d8249-6fe6-4d80-a0ae-f159caef7af0",
      18.              "type": 0,
      19.              "username": "WallyWest",
      20.              "username_lower": "wallywest"
      21.          }
      22.      ]
      23.  }

    4. You can clear all consumers from a group with one request. This may be useful if you need to cycle the group for a new batch of users.

      For example, delete all consumers from the Speedsters group:

      cURL

      HTTPie

      1. curl -i -X DELETE http://{HOSTNAME}:8001/consumer_groups/Speedsters/consumers
      1. http DELETE :8001/consumer_groups/Speedsters/consumers

      Response:

      1.  HTTP/1.1 204 No Content

    5. You can also add a consumer to multiple groups:

      • If all groups are allowed by the Rate Limiting Advanced plugin, only the first group’s settings apply.
      • Otherwise, whichever group is specified in the Rate Limiting Advanced plugin becomes active.

      Add BarryAllen to two groups, JL and Speedsters:

      cURL

      HTTPie

      1. curl -i -X POST http://{HOSTNAME}:8001/consumers/BarryAllen/consumer_groups \
      2.    --data group=JL \
      3.    --data group=Speedsters
      1. http POST :8001/consumers/BarryAllen/consumer_groups \
      2.    group:='["JL", "Speedsters"]'

      The response should look something like this:

      1.  {
      2.    "consumer": {
      3.        "created_at": 1639436091,
      4.        "custom_id": null,
      5.        "id": "6098d577-6741-4cf8-9c86-e68057b8f970",
      6.        "tags": null,
      7.        "type": 0,
      8.        "username": "BarryAllen",
      9.        "username_lower": "barryallen"
      10.    },
      11.    "consumer_groups": [
      12.        {
      13.            "created_at": 1639432267,
      14.            "id": "a905151a-5767-40e8-804e-50eec4d0235b",
      15.            "name": "JL"
      16.        },
      17.        {
      18.            "created_at": 1639436107,
      19.            "id": "2fd2bdd6-690c-4e49-8296-31f55015496d",
      20.            "name": "Speedsters"
      21.        }
      22.    ]
      23.  }

    6. Finally, you can also remove a consumer from all groups:

      cURL

      1. curl -i -X DELETE http://{HOSTNAME}:8001/consumers/BarryAllen/consumer_groups

      Response: