ListApiKeys - ApsaraDB RDS

檢視自訂 API KEY。

介面說明

適用引擎

RDS AI 助手旗艦版。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

rdsai:ListApiKeys

get

*All Resource

*

無

請求參數

名稱	類型	必填	描述	樣本值
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.

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。