创建自定义 API KEY。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| rdsai:CreateApiKey | get | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| InstanceId | string | 否 | 实例名 | rds_copilot***_public_cn-*********6 |
| Quantity | integer | 否 | 创建个数，默认值：1。 | 1 |
| KeyName | string | 否 | API KEY 名 | api-***** |
| LimitType | string | 否 | 限额方式
| fixed |
| LimitRate | double | 否 | 限额比例 | 0.2 |
| TokenQuota | long | 否 | 当前 key 的限额量 | 100000 |
返回参数
示例
正常返回示例
JSON格式
{
"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"
}
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 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. | 该UID并没有有效订单 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2026-04-23 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
| 2026-04-23 | 新增 OpenAPI | 查看变更详情 |