Scenarios
A consumer represents the final API caller, such as an independent application, service, or subsystem. Each consumer needs to configure its identity credentials (such as API Key), used for authentication when accessing the gateway. Consumers must join at least one consumer group to obtain access authorization for model APIs through this group. This article describes how to create, view, edit, and delete consumers, and manage consumers' access credentials.
Operation Steps
Create Consumer and Add Model API
2. On the instance list page, click the "ID" of the gateway instance to be configured to go to its basic information page.
3. Click in the left sidebar Consumer Management > Consumer, go to the Consumer List page.
4. In the "New Consumer" dialog, enter the following information.
|
Consumer name | Yes | Enter a consumer 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. |
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 information for this consumer, which facilitates subsequent management. Up to 200 characters. |
5. Click OK to complete the consumer creation. The system will generate a unique consumer ID for the consumer.
View Consumer Details and Manage Credentials
2. On the instance list page, click the "ID" of the gateway instance to be configured to go to its basic information page.
3. Click in the left sidebar Consumer Management > Consumer, go to the Consumer List page.
4. On the Consumer list page, click the "ID/Name" of any consumer, and the details panel for that consumer will expand on the right side of the page. The details panel is divided into two parts:
Basic Information: Displays this 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".
Manage Credentials: This list displays all keys (credentials) bound to this consumer. You can bind more keys to the consumer by clicking the Add Credential button above.
To add a credential: Click "Add Credential", select the authentication method and specific key in the dialog box, then click OK to complete the binding.
To remove a credential: Click "Unbind", enter the key name in the dialog box to confirm unbinding, then click OK to complete the removal.
Edit Consumer
2. On the instance list page, click the "ID" of the gateway instance to be configured to go to its basic information page.
3. Click Consumer Management > Consumer in the left sidebar to go to the Consumer List page.
4. On the Consumer List page, locate the target consumer and click Edit under the Actions column.
5. In the "Edit Consumer" pop-up window, you can modify the consumer's name and description.
6. After completing modifications, click OK to save.
Note:
Editing operations cannot directly modify the consumer's "Consumer Group" or bound keys. If you need to make changes, view the consumer group in the "Basic Information" section of the Consumer Details page, and manage keys in the "Credentials Management" section.
Delete Consumer
2. On the instance list page, click the "ID" of the gateway instance to be configured to go to its basic information page.
3. Click Consumer Management > Consumer in the left sidebar to go to the Consumer List page.
4. On the "Consumer" list page, locate the target consumer and click Delete under the Operation column. The system will then perform a dependency check before deletion.
5. The system will pop up a window prompting you to confirm deletion and automatically check whether the consumer is bound to other resources.
If there are no dependencies: the pop-up window will display "Can be safely deleted", and click OK to proceed with deletion.
If there are dependencies: the pop-up window will display "There are unresolved dependencies" and list the dependencies.
6. If there are dependencies, you need to first remove all listed dependencies. After removing the dependencies, click the Recheck link in the pop-up window, and the system will perform the validation again.
7. When the validation passes and the dependency prompt disappears, click OK to finally delete the consumer. To cancel the deletion, click Cancel.