Scenarios
Consumer Group is used to logically group consumers (that is, API callers), typically corresponding to different business teams, projects, or applications. By authorizing the Consumer Group, you can batch manage the access permissions of all consumers under it to the model API. This article describes how to create, view, edit, and delete Consumer Groups, and manage the association between Consumer Groups and consumers.
Operation Steps
Create Consumer Group
2. On the instance list page, click the "ID" of the gateway instance to be configured to go to its basic information page.
3. In the left sidebar, click Consumer Management > Consumer Group to go to the Consumer Group list page.
4. In the "New Consumer Group" dialog, enter the following information.
|
Consumer group name | Yes | Enter a consumer group name. The name can contain up to 60 characters, including uppercase and lowercase letters in Chinese and English, digits, and separators ("-", "_"). It cannot start with a digit or a separator, and cannot end with a separator. |
Status | Yes | Controls whether this consumer group is active. The default state 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 add them directly to this group. After creation, you can add or remove consumers at any time. |
Description | No | The description information for this consumer group, which facilitates subsequent management. Up to 200 characters. |
5. Click OK to complete the consumer group creation.
View Consumer Group Details
2. On the instance list page, click the "ID" of the gateway instance to be configured to go to its basic information page.
3. In the left sidebar, click Consumer Management > Consumer Group to go to the Consumer Group list page.
4. On the Consumer Group list page, click the "ID/Name" of any consumer group, and the details panel for that consumer group will expand on the right side of the page.
5. The details panel is divided into two parts: the upper part and the lower part.
Consumer Group Information: This section displays the basic information of this consumer group, including Group ID, Name, Status, Creation Time, Modification Time, and Description.
Consumers: This section displays all consumers associated with this consumer group in list form, including their ID/Name and Description. You can "unlink" associated consumers here.
Edit Consumer Group
2. On the instance list page, click the "ID" of the gateway instance to be configured to go to its basic information page.
3. In the left sidebar, click Consumer Management > Consumer Group to go to the Consumer Group list page.
4. On the Consumer Group list page, locate the target consumer group and click Edit under the Operation column.
5. In the "Edit Consumer Group" dialog box, you can modify the group's Name, Status, and Description.
6. After the modifications are made, click OK to save.
Note:
Editing cannot directly modify consumers associated with the group. To manage associated consumers, see the "Manage Associated Consumers" operation below.
Manage Associated Consumers
Consumers and consumer groups have a many-to-many relationship. A consumer can belong to multiple groups, and a group can include 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 to be configured to go to its basic information page.
3. In the left sidebar, click Consumer Management > Consumer Group to go to the Consumer Group list page.
4. On the Consumer Group list page, locate the target consumer group and click Associate Consumers under the Operation column.
5. In the "Associate Consumers" dialog box, the "Select Consumers" section on the left lists all available consumers. You can quickly search for them using the search box.
6. In the left panel, select one or more consumers to be added to this group. The selected consumers will appear in the "Selected" list on the right.
7. To remove a consumer, click the × icon next to the consumer entry in the "Selected" list on the right to remove it from the group association.
8. After making the adjustments, click OK to save the association.
Delete Consumer Group
2. On the instance list page, click the "ID" of the gateway instance to be configured to go to its basic information page.
3. In the left sidebar, click Consumer Management > Consumer Group to go to the Consumer Group list page.
4. On the Consumer Group list page, locate the target consumer group and click Delete under the Operation column. The system will then perform a dependency check before deletion.
5. The system will pop up a dialog box prompting you to confirm the deletion and automatically check whether the consumer group is bound to other resources (such as "Model API" authorization).
If there are no dependencies: the pop-up window will display "Can be safely deleted", and click Confirm to proceed with deletion.
If there are dependencies: the pop-up window will display "Resource Deletion Dependency Check Results: There are unresolved dependencies" and list the specific dependencies.
6. If there are dependencies, you need to first remove all listed dependencies. After the dependencies are removed, click the Recheck link in the pop-up window, and the system will perform the validation again.
7. When the validation passes and the prompt changes to "Can be safely deleted", click Confirm to delete. After deletion, all consumers under this group will immediately lose the access permissions to model APIs obtained through this group. To cancel the deletion, click Cancel.