CreateApiKey - 创建自定义 API KEY-云数据库 RDS(RDS)-阿里云帮助中心

创建自定义 API KEY。

接口说明

适用引擎

RDS AI 助手旗舰版

调试

您可以在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	否	限额方式按比例：ratio 固定值：fixed 自动分配：auto 枚举值： auto : auto fixed : fixed ratio : ratio	fixed
LimitRate	number	否	限额比例	0.2
TokenQuota	integer	否	当前 key 的限额量	100000
DailyTokenQuota	integer	否	apikey 的每日限额	1000000000
RoleName	string	否
RoleArn	string	否

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	Id of the request	FE9C65D7-930F-57A5-A207-8C396329****
Success	boolean	请求结果。	true
Message	string	返回消息。	success
Data	object	返回数据
CustomKeyList	array<object>	自定义 API KEY 列表
	object
ApiKey	string	Api Key	sk-rds-*****
KeyName	string	API KEY 名	api-*****
TokenQuota	integer	当前 key 的限额量	100000
DailyTokenQuota	integer	apikey 的每日限额	0
LimitType	string	限额方式，取值： fixed：按固定值。 ratio：按百分比。 auto：自动分配。	fixed
LimitRate	number	限额比例	0.2
RoleArn	string
BaseUrl	string	模型调用 url	http://xxx.yy/v1
SystemApiKey	string	系统生成的 key	sk-rds-xxx

示例

正常返回示例

JSON格式

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

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidIpWhitelistError	Invalid IP address or CIDR in whitelist.	白名单中的IP地址或CIDR不合法。
400	DomainNotReadyError	Domain is not ready yet, please try again later.	域名尚未就绪。
400	InstanceQuotaExceededError	Instance quota exceeded, cannot create new API key.	实例配额已用尽，无法创建新API密钥。
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.	后付费实例不支持比例配额模式。
400	MoProLikeCustomKeyNotAllowed	Custom API keys are not supported for Pro or Enterprise instances.	专业版或专业版（智算版）MO禁止创建自定义Key。
400	InvalidQuantityError	Invalid quantity: must be an integer between 1 and 50.	数量必须为1到50之间的整数。
403	InvalidUserOrder	There is no valid order for this UID.	该UID并没有有效订单

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。