DescribeAIDBClusterApiKeys - PolarDB - Alibaba Cloud ドキュメントセンター

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

polardb:DescribeAIDBClusterApiKeys

get

*All Resource

*

なし

リクエスト構文

POST  HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	リージョン ID。	cn-beijing
		任意	モデルスペースの ID。	pms-xxx

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンススキーマ。
RequestId	string	リクエストの ID。	7F2007D3-7E74-4ECB-89A8-BF130D******
ApiKeys	array<object>	API キー。
	object	API キー。
ApiKey	string	モデルサービスの API キー。	Scxxx-xxx-x-xxWW
Description	string	API キーの説明。	my api key
Status	string	API キーのステータス。	active
CreateTime	string	作成時間。	2026-04-09T03:19:19Z
Id	string	API キーの ID。	573
PageNumber	string
PageSize	string

例

成功レスポンス

JSONJSON

{
  "RequestId": "7F2007D3-7E74-4ECB-89A8-BF130D******",
  "ApiKeys": [
    {
      "ApiKey": "Scxxx-xxx-x-xxWW。",
      "Description": "my api key。",
      "Status": "active。",
      "CreateTime": "2026-04-09T03:19:19Z",
      "Id": "573"
    }
  ],
  "PageNumber": "",
  "PageSize": ""
}

エラーコード

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

変更履歴

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