ListApiKeys - 查看自定义 API KEY-云数据库 RDS(RDS)-阿里云帮助中心

查看自定义 API KEY

接口说明

适用引擎

RDS AI 助手旗舰版

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

rdsai:ListApiKeys

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	否	实例名	rds_copilot*_public_cn-*******6
Page	integer	否	页码	1
PageSize	integer	否	每页记录数	10

返回参数

名称	类型	描述	示例值
	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 的限额量	10000
DailyTokenQuota	integer		100000000
LimitType	string	限额方式，取值： fixed：按固定值。 ratio：按百分比。 auto：自动分配。	fixed
LimitRate	number	限额比例	0.2
IsRateLimited	boolean	是否被限流	false
ThresholdPercent	integer	告警阈值百分比，80 表示使用量到达 80 % 之后，会进行一次告警，使用额度低于该百分比之后会重置	80
BaseUrl	string	模型调用 url	http://xxx.yy/v1
SystemApiKey	string	系统生成的 key	sk-rds-xxx
Total	integer	总记录数	138
ThresholdPercent	integer	SystemApiKey 告警阈值百分比，80 表示使用量到达 80 % 之后，会进行一次告警，使用额度低于该百分比之后会重置	80
DailyTokenQuota	integer		100000000
Page	integer	页码。	1
PageSize	integer	每页记录数。	10
IsRateLimited	boolean	是否被限流	false

示例

正常返回示例

JSON格式

{
  "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
  }
}

错误码

HTTP status code	错误码	错误信息	描述
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.	该UID并没有有效订单

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

变更历史

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