ListApiKeys-阿里云帮助中心

View Custom API Key

Operation description

Supported engines

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 entries per page.	10

Response elements

Element	Type	Description	Example
	object	The response data.
RequestId	string	The unique request ID.	FE9C65D7-930F-57A5-A207-8C396329****
Success	boolean	Indicates if the request succeeded.	true
Message	string	The response message.	success
Data	object	The response data.
CustomKeyList	array<object>	The custom API key list.
	object
ApiKey	string	The API key.	sk-rds-*****
KeyName	string	The key name.	api-*****
TokenQuota	integer	The token quota.	10000
LimitType	string	The limit type. Valid values: fixed: A fixed value. ratio: A percentage of the total quota. auto: The quota is allocated automatically.	fixed
LimitRate	number	The limit, specified as a ratio in decimal format. This parameter is used when LimitType is ratio.	0.2
IsRateLimited	boolean	Specifies if the API key is rate-limited.	false
ThresholdPercent	integer	The alarm threshold percentage. For example, a value of 80 indicates that an alarm is triggered when usage reaches 80% of the quota. The alarm clears when usage falls below this threshold.	80
BaseUrl	string	The base URL for model calls.	http://xxx.yy/v1
SystemApiKey	string	The system-generated key.	sk-rds-xxx
Total	integer	The total number of entries.	138
ThresholdPercent	integer	The alarm threshold percentage for the SystemApiKey. For example, a value of 80 indicates that an alarm is triggered when usage reaches 80% of the quota. The alarm clears when usage falls below this threshold.	80
Page	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
IsRateLimited	boolean	Specifies if the system-generated key is rate-limited.	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,
        "LimitType": "fixed",
        "LimitRate": 0.2,
        "IsRateLimited": false,
        "ThresholdPercent": 80
      }
    ],
    "BaseUrl": "http://xxx.yy/v1",
    "SystemApiKey": "sk-rds-xxx",
    "Total": 138,
    "ThresholdPercent": 80,
    "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.
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.