CreateApiKey-阿里云帮助中心

Create a 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:CreateApiKey

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	No	The instance ID.	rds_copilot*_public_cn-*******6
Quantity	integer	No	The number of API keys to create. The default value is 1.	1
KeyName	string	No	The name of the API key.	api-*****
LimitType	string	No	The limit type. Valid values: ratio: Proportional limit. fixed: Fixed limit. auto: Automatic limit. Valid values: auto : Automatic limit. fixed : Fixed limit. ratio : Proportional limit.	fixed
LimitRate	number	No	The limit ratio.	0.2
TokenQuota	integer	No	The token quota for the API key.	100000

Response elements

Element	Type	Description	Example
	object	The response body.
RequestId	string	The request ID.	FE9C65D7-930F-57A5-A207-8C396329****
Success	boolean	Indicates whether the request was successful.	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 API key name.	api-*****
TokenQuota	integer	The token quota for the key.	100000
LimitType	string	The limit type. Valid values: fixed: Sets the quota to a fixed value. ratio: Sets the quota based on a percentage. auto: Automatically allocates the quota.	fixed
LimitRate	number	The limit ratio.	0.2
BaseUrl	string	The model invocation URL.	http://xxx.yy/v1
SystemApiKey	string	The system API key.	sk-rds-xxx

Examples

Success response

JSON format

{
  "RequestId": "FE9C65D7-930F-57A5-A207-8C396329****",
  "Success": true,
  "Message": "success",
  "Data": {
    "CustomKeyList": [
      {
        "ApiKey": "sk-rds-*****",
        "KeyName": "api-*****",
        "TokenQuota": 100000,
        "LimitType": "fixed",
        "LimitRate": 0.2
      }
    ],
    "BaseUrl": "http://xxx.yy/v1",
    "SystemApiKey": "sk-rds-xxx"
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidIpWhitelistError	Invalid IP address or CIDR in whitelist.
400	DomainNotReadyError	Domain is not ready yet, please try again later.
400	InstanceQuotaExceededError	Instance quota exceeded, cannot create new API key.
400	CustomKeyLimitExceededError	Custom key limit exceeded.
400	InstanceNotFoundError	No active instance found.
400	InvalidQuotaValueError	LimitType must be fixed or ratio. TokenQuota must be a positive integer and limitRate must be between 0.0 and 1.0.
400	QuotaSumExceededError	Sum of custom key quotas exceeds instance total quota.
400	MoPostpayRatioNotAllowedError	Ratio mode is not supported for POSTPAY instances. Use 'fixed' mode instead.
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.