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

指定された PolarDB クラスターの TDE (透過的データ暗号化) の設定詳細を照会します。

今すぐお試しください

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

get

*dbcluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBClusterId	string	必須	クラスター ID。	pc-***************

description

レスポンスフィールド

フィールド	型	説明	例
	object
AutomaticRotation	string	キーの自動ローテーションが許可されているかどうかを示します。有効な値： Enabled：キーの自動ローテーションが許可されています。 Disabled：キーの自動ローテーションは許可されていません。説明このパラメーターは、データベースエンジンが PostgreSQL または Oracle 構文と互換性がある場合にのみ返されます。	Enabled
DBClusterId	string	クラスターの一意の ID。	pc-***************
EncryptNewTables	string	新しく作成されたすべてのテーブルに対して自動暗号化が有効になっているかどうかを示します。有効な値： ON：自動暗号化が有効になっています。 OFF：自動暗号化が無効になっています。説明このパラメーターは、データベースエンジンが MySQL と互換性がある場合にのみ返されます。	ON
EncryptionKey	string	カスタムキーの ID。	2a4f4ac2-**---**********
RequestId	string	リクエストの一意の ID。	E37D1508-EC3B-4E06-A24A-C7AC31******
RotationInterval	string	KMS で設定されたキーの自動ローテーション間隔。キーの自動ローテーション間隔が設定されていない場合、0s が返されます。単位：秒。たとえば、ローテーション間隔が 7 日の場合、604800s が返されます。説明このパラメーターは、データベースエンジンが PostgreSQL または Oracle 構文と互換性があり、かつ `AutomaticRotation` の値が `Enabled` である場合にのみ返されます。	604800s
TDERegion	string	TDE キーが配置されているリージョン。	cn-beijing
TDEStatus	string	TDE 暗号化が有効になっているかどうかを示します。有効な値： Enabled：TDE 暗号化が有効になっています。 Disabled：TDE 暗号化が無効になっています。	Enabled
EncryptionKeyStatus	string	キーのステータス。有効な値： Enabled：キーは有効です。 Disabled：キーは無効です。	Enabled

description

例

成功レスポンス

JSONJSON

{
  "AutomaticRotation": "Enabled",
  "DBClusterId": "pc-***************",
  "EncryptNewTables": "ON",
  "EncryptionKey": "2a4f4ac2-****-****-****-************",
  "RequestId": "E37D1508-EC3B-4E06-A24A-C7AC31******",
  "RotationInterval": "604800s",
  "TDERegion": "cn-beijing",
  "TDEStatus": "Enabled",
  "EncryptionKeyStatus": "Enabled"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.
404	InvalidDBClusterId.NotFound	The DBClusterId provided does not exist in our records.
404	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.

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

変更履歴

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