Scenarios
A consumer group is used to logically group consumers (that is, API callers), typically corresponding to different business teams, projects, or applications. By authorizing a consumer group, you can manage the access permissions of all consumers under it to the model API in batches. This document describes how to create, view, edit, and delete consumer groups, as well as manage the associations between consumer groups and consumers.
Operation Steps
Creating a Consumer Group
2. On the instance list page, click the ID of the gateway instance you want to configure to go to its basic information page.
3. In the left sidebar, click Consumer Management > Consumer Groups to go to the consumer group list page.
4. In the Create Consumer Group dialog box, enter the following information.
|
Consumer group name | Yes | Enter the consumer group name. It can contain up to 60 characters, supporting uppercase and lowercase letters in both Chinese and English, digits, and separators ("-", "_"). It cannot start with a digit or separator, and cannot end with a separator. |
Status | Yes | Controls whether this consumer group is active. The default status is "enabled". After it is disabled, all consumers in the group cannot access any APIs through the gateway. |
Consumer | No | Select one or more existing consumers from the list and directly add them to this group. You can add or remove consumers at any time after creation. |
Description | No | The description of this consumer group, which facilitates subsequent management. It can contain up to 200 characters. |
5. Click OK to complete the creation of the consumer group.
Viewing Consumer Group Details
2. On the instance list page, click the ID of the gateway instance you want to configure to go to its basic information page.
3. In the left sidebar, click Consumer Management > Consumer Groups to go to the consumer group list page.
4. On the Consumer Group list page, click the ID/Name of any consumer group. The details panel for that consumer group will be displayed on the right side of the page.
5. The details panel is divided into two sections:
Consumer Group Information: Displays the basic information of this consumer group, including its ID, name, status, creation time, modification time, and description.
Consumers: Displays all consumers that are associated with this consumer group in a list, including their IDs/names and descriptions. You can disassociate the associated consumers here.
Editing a Consumer Group
2. On the instance list page, click the ID of the gateway instance you want to configure to go to its basic information page.
3. In the left sidebar, click Consumer Management > Consumer Groups to go to the consumer group list page.
4. On the consumer group list page, locate the target consumer group and click the Edit icon in its upper-right corner.
5. In the Edit Consumer Group dialog box, you can modify the group's name, status, and description.
6. After making the modifications, click OK to save.
Attention:
The edit operation cannot directly modify the consumers associated with the group. To manage associated consumers, see the Manage Associated Consumers operation below.
Managing Associated Consumers
Consumers and consumer groups have a many-to-many relationship. A consumer can belong to multiple groups, and a group can contain multiple consumers. You can add or remove consumers for a consumer group.
2. On the instance list page, click the ID of the gateway instance you want to configure to go to its basic information page.
3. In the left sidebar, click Consumer Management > Consumer Groups to go to the consumer group list page.
4. On the consumer group list page, locate the target consumer group and click Associate Consumers in its operation column.
5. In the Associate Consumers dialog box, the left-side "Select Consumers" area lists all available consumers. You can use the search box to quickly find them.
6. In the list on the left, select one or more consumers to add to this group. The selected consumers will appear in the "Selected" list on the right.
7. To remove a consumer, click the × icon to the right of its entry in the "Selected" list on the right. This will remove it from the group's associations.
8. After making the adjustments, click OK to save the association.
Deleting a Consumer Group
2. On the instance list page, click the ID of the gateway instance you want to configure to go to its basic information page.
3. In the left sidebar, click Consumer Management > Consumer Groups to go to the consumer group list page.
4. On the Consumer Groups list page, locate the target consumer group and click Delete in its upper-right corner. The system will then perform a dependency check before deletion.
5. The system will display a pop-up window asking you to confirm the deletion and automatically check whether the consumer group is bound to any other resources, such as a model API authorization.
If no dependencies exist, the pop-up window will display the message "Safe to delete". Click OK to delete it.
If dependencies exist, the pop-up window will display the message "Resource Deletion Dependency Check Result: Unresolved dependencies exist" and list the specific dependency items.
6. If dependencies exist, you must first remove all listed dependencies. After the dependencies are removed, click the Recheck link in the pop-up window. The system will then perform the check again.
7. After the check passes and the prompt changes to "Safe to delete", click OK to delete it. After deletion, all consumers under this group will immediately lose the model API access permissions they obtained through this group. To cancel the deletion, click Cancel.