ListApiKeys - ApsaraDB RDS - Alibaba Cloud Documentation Center

Queries custom API keys.

Operation description

Applicable engine

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

rdsai:ListApiKeys

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	No	The instance ID.	rds_copilot*_public_cn-*******6
Page	integer	No	The page number.	1
PageSize	integer	No	The number of records per page.	10

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	FE9C65D7-930F-57A5-A207-8C396329****
Success	boolean	The request result.	true
Message	string	The response message.	success
Data	object	The query result.
CustomKeyList	array<object>	The list of custom API keys.
	object
ApiKey	string	API Key	sk-rds-*****
KeyName	string	The API key name.	api-*****
TokenQuota	integer	The quota of the current key.	10000
DailyTokenQuota	integer		100000000
LimitType	string	The quota type. Valid values: fixed: fixed value. ratio: percentage. auto: automatic allocation.	fixed
LimitRate	number	The quota ratio.	0.2
IsRateLimited	boolean	Indicates whether the key is throttled.	false
ThresholdPercent	integer	The alert threshold percentage. For example, 80 indicates that an alert is triggered when the usage reaches 80%. The alert resets when the usage drops below this percentage.	80
BaseUrl	string	The URL for model invocation.	http://xxx.yy/v1
SystemApiKey	string	The system-generated key.	sk-rds-xxx
Total	integer	The total number of records.	138
ThresholdPercent	integer	The alert threshold percentage for SystemApiKey. For example, a value of 80 indicates that an alert is triggered when the usage reaches 80%. The alert resets when the usage drops below this percentage.	80
DailyTokenQuota	integer		100000000
Page	integer	The page number.	1
PageSize	integer	The number of records per page.	10
IsRateLimited	boolean	Indicates whether the key is throttled.	false

Examples

Success response

JSON format

{
  "RequestId": "FE9C65D7-930F-57A5-A207-8C396329****",
  "Success": true,
  "Message": "success",
  "Data": {
    "CustomKeyList": [
      {
        "ApiKey": "sk-rds-*****",
        "KeyName": "api-*****",
        "TokenQuota": 10000,
        "DailyTokenQuota": 100000000,
        "LimitType": "fixed",
        "LimitRate": 0.2,
        "IsRateLimited": false,
        "ThresholdPercent": 80
      }
    ],
    "BaseUrl": "http://xxx.yy/v1",
    "SystemApiKey": "sk-rds-xxx",
    "Total": 138,
    "ThresholdPercent": 80,
    "DailyTokenQuota": 100000000,
    "Page": 1,
    "PageSize": 10,
    "IsRateLimited": false
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	MoInvalidIpWhitelistError	Invalid IP address or CIDR in whitelist.
400	MoDomainNotReadyError	Domain is not ready yet, please try again later.
400	InvalidPageParamError	Invalid pagination parameter: page must be >= 1, pageSize must be between 1 and 100.
403	InvalidUserOrder	There is no valid order for this UID.	There is no valid order for this UID

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.