DescribeDBClusterEncryptionKey API リファレンス - PolarDB

指定された PolarDB クラスターのキー使用状況の詳細を照会します。

操作説明

説明

この操作を呼び出して、キー ID、ステータス、タイプなど、PolarDB クラスターのキー使用状況の詳細を照会できます。
DBClusterId パラメーターは必須です。照会する PolarDB クラスターの ID を指定します。
この操作を呼び出す前に、必要な Resource Access Management (RAM) ロールとポリシーが設定されていることを確認してください。

今すぐお試しください

この 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:DescribeDBClusterEncryptionKey

get

*All Resource

*

なし

リクエスト構文

POST  HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ClientToken	string	任意	リクエストのべき等性を保証するためのクライアントトークン。	6000170000591aed949d0f******************
DBClusterId	string	任意	クラスター ID。説明 DescribeDBClusters 操作を呼び出して、クラスター ID を含む、アカウント内のすべてのクラスターの詳細を照会します。	pc-***

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスボディ。
RequestId	string	リクエスト ID。	137ECCC0-920E-5B3B-9F8E-B81632108BBE
EncryptionKeyList	array<object>	キーのリスト。
	object	キーの詳細。
AliasName	string	キーのエイリアス。	alias/your_default_key
Creator	string	キーを作成した Alibaba Cloud アカウントの UID。	1****1
DeleteDate	string	キーを削除するスケジュールされた時間。フォーマットは yyyy-MM-ddTHH:mm:ssZ (UTC) です。キーが削除の対象としてスケジュールされていない場合、このフィールドは空です。	2026-05-08T08:14:16Z
Description	string	キーの説明。	Description of the key
EncryptionKey	string	キー ID。	51858179-afb3-4369-8329-*********
EncryptionKeyStatus	string	キーのステータス。有効な値: Enabled: キーは有効です。 Disabled: キーは有効ではありません。	Enabled
KeyType	string	キーのタイプ。有効な値: CMK: カスタマーマスターキー ServiceKey: サービスキー	ServiceKey
KeyUsage	string	キーの目的。	ENCRYPT/DECRYPT
MaterialExpireTime	string	キーの有効期限。フォーマットは yyyy-MM-ddTHH:mm:ssZ (UTC) です。	2025-10-18T08:14:16Z
Origin	string	キーのソース。	Aliyun_KMS
UsedBy	string	キーを使用するサービス。有効な値: TDE: TDE (透過的データ暗号化)。 DiskEncryption: ディスク暗号化。	DiskEncryption

例

成功レスポンス

JSONJSON

{
  "RequestId": "137ECCC0-920E-5B3B-9F8E-B81632108BBE",
  "EncryptionKeyList": [
    {
      "AliasName": "alias/your_default_key",
      "Creator": "1****1",
      "DeleteDate": "2026-05-08T08:14:16Z",
      "Description": "Description of the key",
      "EncryptionKey": "51858179-afb3-4369-8329-*********",
      "EncryptionKeyStatus": "Enabled",
      "KeyType": "ServiceKey",
      "KeyUsage": "ENCRYPT/DECRYPT",
      "MaterialExpireTime": "2025-10-18T08:14:16Z",
      "Origin": "Aliyun_KMS",
      "UsedBy": "DiskEncryption"
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	IdempotentParameterMismatch	The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.
404	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.
404	InvalidDBClusterId.NotFound	The DBInstanceId provided does not exist in our records.
404	InvalidDBInstance.NotFound	The DBClusterId provided does not exist in our records.

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

変更履歴

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