DescribeDBInstanceEncryptionKey を使用した暗号鍵詳細のクエリ - MongoDB

操作説明

DescribeDBInstanceEncryptionKey 操作を呼び出す場合、インスタンスで BYOK モードの TDE (透過的データ暗号化) が有効になっている必要があります。ModifyDBInstanceTDE 操作を呼び出して 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

dds:DescribeDBInstanceEncryptionKey

get

*Instance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBInstanceId	string	必須	インスタンス ID。	dds-bp2235****
EncryptionKey	string	任意	インスタンスのカスタムキー。DescribeUserEncryptionKeyList 操作を呼び出して、ApsaraDB for MongoDB インスタンスのカスタムキーのリストを照会できます。	2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

レスポンスフィールド

フィールド	型	説明	例
	object	返されるデータ。
Origin	string	インスタンスのキーのソース。	Aliyun_KMS
Description	string	インスタンスのキーの説明。	key description example
RequestId	string	リクエスト ID。	783C2062-A2D3-4EA8-88AD-E43F990C23BB
EncryptionKeyStatus	string	インスタンスのキーが有効かどうかを示します。有効な値： Enabled Disabled	Enabled
MaterialExpireTime	string	インスタンスのキーの有効期限。時刻は UTC で表示されます。このパラメーターが空の場合、インスタンスのキーは期限切れになりません。	2020-07-06T18:22:03Z
KeyUsage	string	インスタンスのキーの目的。	ENCRYPT/DECRYPT
EncryptionKey	string	インスタンスのキー。	2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Creator	string	キー作成者の UID。	123456
DeleteDate	string	インスタンスのキーが削除されるようにスケジュールされた時刻。このパラメーターが空の場合、キーは削除されません。	2020-07-06T18:22:03Z

例

成功レスポンス

JSONJSON

{
  "Origin": "Aliyun_KMS",
  "Description": "key description example",
  "RequestId": "783C2062-A2D3-4EA8-88AD-E43F990C23BB",
  "EncryptionKeyStatus": "Enabled",
  "MaterialExpireTime": "2020-07-06T18:22:03Z",
  "KeyUsage": "ENCRYPT/DECRYPT",
  "EncryptionKey": "2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "Creator": "123456",
  "DeleteDate": "2020-07-06T18:22:03Z"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
403	INVALID_INSNAME_REGIONID_EMPTY	The insName and regionId can't be all empty
403	NO_ACTIVE_BYOK	This custins no active byok.

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

変更履歴

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