Scenarios
A consumer represents the final API caller, such as an independent application, service, or subsystem. Each consumer must configure its identity credentials (such as an API Key) for authentication when accessing the gateway. A consumer must join at least one consumer group to obtain access authorization for the model API through that group. This document describes how to create, view, edit, and delete consumers, as well as manage their access credentials.
Operation Steps
Creating Consumers
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 > Consumers to go to the consumer list page.
4. In the Create Consumer dialog box, enter the following information.
|
Consumer name | Yes | Enter the consumer 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. |
Consumer group | No | Select one or more existing consumer groups from the drop-down list. A consumer must belong to at least one group to obtain API access permissions. |
Selecting a secret | No | Select one or more created keys from the drop-down list as the identity credentials for this consumer. You can also quickly create a key by clicking the "New Key" link to jump to the key management page. |
Description | No | The description of this consumer, which facilitates subsequent management. It can contain up to 200 characters. |
5. Click OK to complete the consumer creation. The system generates a unique consumer ID for the consumer.
Viewing Consumer Details and Managing Credentials
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 > Consumers to go to the consumer list page.
4. On the Consumer list page, click the ID/Name of any consumer. The consumer details panel expands on the right side of the page. The details panel consists of two parts:
Basic Information: Displays the consumer's ID, name, consumer group, creation time, modification time, and description.
Credential Management:
Authentication Method: Displays the currently used authentication method, such as "API Key".
Credential Management: This list displays all keys (credentials) bound to this consumer. You can use the Add Credential button above to bind more keys to the consumer.
To add a credential: Click Add Credential. In the dialog box that appears, select an authentication method and a specific key, and then click OK to complete the binding.
To remove a credential: Click Unbind. In the dialog box that appears, enter the key name to confirm unbinding, and then click OK to complete the removal.
Editing a Consumer
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 > Consumers to go to the consumer list page.
4. On the consumer list page, locate the target consumer and click the Edit icon in its upper-right corner.
5. In the Edit Consumer dialog box, you can modify the consumer's name and description.
6. After making the modifications, click OK to save.
Attention:
The Associated Consumer Group and bound keys of a consumer cannot be directly modified through the edit operation. To modify them, view the associated group in the Basic Information section of the consumer details page, and manage keys in the Credential Management section.
Deleting a Consumer
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 > Consumers to go to the consumer list page.
4. On the Consumers list page, locate the target consumer and click the Delete icon 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 is bound to any other resources.
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 "Unresolved dependencies exist" and list the dependent 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 dependency warning disappears, click OK to finally delete the consumer. To cancel the deletion, click Cancel.