ListApiKeys - ApsaraDB RDS - Alibaba Cloud ドキュメントセンター

カスタム API キーを照会します。

操作説明

対象エンジン

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

rdsai:ListApiKeys

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	任意	インスタンスの ID。	rds_copilot*_public_cn-*******6
Page	integer	任意	ページ番号。	1
PageSize	integer	任意	1 ページあたりのレコード数。	10

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスのスキーマ。
RequestId	string	リクエストの ID。	FE9C65D7-930F-57A5-A207-8C396329****
Success	boolean	リクエストの結果。	true
Message	string	応答メッセージ。	success
Data	object	クエリの結果。
CustomKeyList	array<object>	カスタム API キーのリスト。
	object
ApiKey	string	API キー。	sk-rds-*****
KeyName	string	API キーの名前。	api-*****
TokenQuota	integer	現在のキーのクォータ。	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	システム生成のキー。	sk-rds-xxx
Total	integer	レコードの総数。	138
ThresholdPercent	integer	SystemApiKey のアラートのしきい値のパーセンテージ。例えば、値が 80 の場合、使用量が 80% に達するとアラートがトリガーされます。使用量がこのパーセンテージを下回ると、アラートはリセットされます。	80
DailyTokenQuota	integer		100000000
Page	integer	ページ番号。	1
PageSize	integer	1 ページあたりのレコード数。	10
IsRateLimited	boolean	キーがスロットリングされているかどうかを示します。	false

例

成功レスポンス

JSONJSON

{
  "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 ステータスコード	エラーコード	エラーメッセージ
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.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。