Scenarios
Consumer tags are used to govern API access in the Key-Value dimension. Tag values available to consumers are centrally managed on the Consumer Management > Consumer Tags page, and after they are added/modified, they become visible to all consumer management, quota, rate limiting, and authentication and authorization modules.
A tag is in the Key:Value (KV) format, for example, "Department:Engineering", "Environment:Production", and "Level:VIP". Different tag keys are independent of each other, and a consumer can be bound to multiple tags. Tags with different keys can coexist, while only the latest value is retained for tags with the same key.
With consumer tags, you can:
Enable policies such as quota, rate limiting, and authentication and authorization to dynamically match by tag dimension, rather than configuring them for each consumer individually.
When team members change, existing tag policies are automatically inherited after consumers are added/removed.
View which policies reference a tag, and check dependencies before deletion.
Prerequisites
An AI Gateway instance has been created, and its status is Running.
If you need to bind tags, ensure that a consumer has been created.
Operation Steps
Step 1: Creating a Consumer Tag
1. Log in to the AI Gateway console and select the target gateway instance to go to its details page. 2. In the left sidebar, select Consumer Management to go to the consumer management page. The page provides four tabs: Consumer Groups, Consumers, Consumer Tags, and Consumer Keys.
3. Select the Consumer Tags tab and click Create Tag.
4. In the "Create Consumer Tag" dialog, configure the following parameters:
|
Tag Key | Yes | Enter a tag category, such as department / environment / level. |
Tag Value | Yes | Enter a tag value, such as: technical department / production / VIP. Tags are in Key:Value format. Tags with the same Key overwrite each other (a consumer retains only the latest Value for the same Key); different Keys are independent of each other (a consumer can be bound to department:technical department + environment:production at the same time). |
Description | No | Enter a tag description, up to 200 characters. |
Associate Consumers | No | Select consumers from the dropdown list (search and refresh supported). You can select multiple consumers at the same time, or click Create Consumer to quickly create one. Each tag can be bound to multiple consumers, up to 50. |
5. Click Confirm to complete the creation.
Note:
Each tag can be bound to up to 50 consumers at the same time. Tags with the same Key overwrite each other, while tags with different keys are independent of each other. After a tag is created, you can continue to manage its binding relationships on the Associated Consumers tab.
The tag list is displayed in a table, where each row shows the tag name (Key:Value) and the number of associated consumers. You can search by Key:Value using the search box above the list, and refresh the list.
The list supports pagination, with 20 entries per page by default.
Step 2: Associating a Consumer
After a tag is created, you can continue to manage its binding relationships on the "Associated Consumers" tab in the tag details.
1. In the consumer tag list, click the target tag (Key:Value). A tag details panel will expand on the right.
2. Select the Associated Consumers tab. The page displays a list of consumers bound to the tag, with the following columns: ID/Name, Consumer Group, Tag Status, Description, and Actions. You can search by consumer ID or name.
3. Click the Associate Consumers button, and in the dialog, select consumers using the transfer list:
On the left, select consumers from the consumer dropdown list (search by consumer ID or name is supported) to add them to the candidate list.
On the right, the Selected list displays the selected consumers.
The top of the dialog displays the tag value (for example, Department:Technical Department) and the number of selected consumers.
4. Click OK to complete the binding.
Step 3: Viewing Tag Details and Reference Summary
Click the target tag in the tag list. A details panel will expand on the right, containing three tabs and the Edit and Delete buttons.
The Basic Information tab displays:
|
Tag Key | Tag category. |
Tag Value | Tag value. |
Status | Tag status. |
Associated Consumer Quantity | Number of consumers currently bound to the tag. |
Creation Time | Tag creation time. |
Modification time | Last modified time. |
Description | Tag description. |
The Reference Summary tab displays a list of policies that reference the tag, with the following columns:
|
Reference Type | Policy type that references the tag. |
Referenced Content | Specific content of the policy. |
Referenced Resource ID | Resource ID associated with the policy. |
Step 4: Editing a Tag
1. In the tag details panel, click Edit.
2. In the Edit Consumer Tag dialog, modify the tag Key, tag Value, or description. The rules are the same as those for creating a tag.
3. Click OK to save the changes.
Note:
The edit dialog does not include the "Associated Consumers" configuration. Manage binding relationships in the Associated Consumers tab.
Step 5: Deleting a Tag
1. In the tag details panel, click Delete.
2. In the Delete Consumer Tag dialog, the system automatically performs a Resource Deletion Dependency Check and displays the check results and dependency statistics:
Associated Consumers: N
Authentication and Authorization / Rate Limiting Rule References: N
If dependencies change, click Recheck to verify again.
3. After confirming the check results, click OK to complete the deletion.
Referencing a Tag
Quota Management: When creating or editing a quota rule, you can select consumer tags as the quota target. The quota then applies to all consumers matching the tag, enabling team-level quota control.
Rate Limiting Policy: Rate limiting conditions can be filtered by consumer tags and support tag combinations. The effective scope of a rate limiting policy automatically matches the corresponding consumers.
Authentication and Authorization: Model API authentication and authorization supports authorization by consumer tags. All consumers matching the tags automatically gain access.
Parameter Description
|
Tag format | Key:Value, such as department:technical department, environment:production, and level:VIP. |
Key Rule | Keys of different tags are independent of each other. |
Value Rule | Only the latest bound value is retained for the same Key. |
Binding Relationship | A consumer can be bound to multiple tags with different Keys. Each tag can be bound to up to 50 consumers. |
Deletion Impact | Deleting a tag does not affect existing quotas or rate limiting rules. The tag is automatically unbound from all associated consumers. |