DescribeEncryptionKey - Tair (Redis® OSS-Compatible) - Alibaba Cloud ドキュメントセンター

Tair (Redis OSS-compatible) インスタンスが透過的データ暗号化 (TDE) を利用する際に使用するカスタムキーの詳細を照会します。

操作説明

本操作を呼び出す前に、Tair (Redis OSS-compatible) インスタンスに対してカスタムキーを用いた TDE を有効化しておく必要があります。詳細については、「ModifyInstanceTDE」をご参照ください。

説明

TDE の詳細については、「Enable 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

kvstore:DescribeEncryptionKey

get

*DBInstance

acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	必須	インスタンスの ID です。インスタンス ID は、「DescribeInstances」操作を呼び出して照会できます。	r-bp1zxszhcgatnx****
EncryptionKey	string	任意	カスタムキーの ID です。キーの ID は、「DescribeEncryptionKeyList」操作を呼び出して照会できます。	ad463061-992d-4195-8a94-ed63********

レスポンスフィールド

フィールド	型	説明	例
	object
DeleteDate	string	カスタムキーの予定削除時刻です。時刻は ISO 8601 標準に従い、yyyy-MM-ddTHH:mm:ssZ 形式で表されます。時刻は協定世界時 (UTC) で表示されます。説明戻り値が空文字列の場合、カスタムキーは自動的に削除されません。	2021-09-24T18:22:03Z
RequestId	string	リクエストの ID です。	9A931CE5-C926-5E09-B0EC-6299C4A6****
Description	string	カスタムキーの説明文です。デフォルトでは空文字列が返されます。	testkey
Origin	string	カスタムキーのソースです。Aliyun_KMS の値は、Alibaba Cloud の Key Management Service (KMS) を示します。	Aliyun_KMS
MaterialExpireTime	string	カスタムキーの有効期限切れ時刻です。時刻は ISO 8601 標準に従い、yyyy-MM-ddTHH:mm:ssZ 形式で表されます。時刻は協定世界時 (UTC) で表示されます。説明戻り値が空文字列の場合、カスタムキーには有効期限がありません。	2021-09-24T18:22:03Z
EncryptionKeyStatus	string	カスタムキーの状態です。有効な値は以下のとおりです。 Enabled：カスタムキーは利用可能です。 Disabled：カスタムキーは利用できません。	Enabled
KeyUsage	string	カスタムキーの用途です。`ENCRYPT/DECRYPT` の値は、暗号化および復号を意味します。	ENCRYPT/DECRYPT
EncryptionKey	string	カスタムキーの ID です。	ad463061-992d-4195-8a94-ed63********
Creator	string	カスタムキーを作成した Alibaba Cloud アカウントの ID です。	17649847********
EncryptionName	string	暗号化アルゴリズムです。	AES-CTR-256
RoleArn	string	権限を付与する Resource Access Management (RAM) ロールの Alibaba Cloud リソースネーム (ARN) です。	acs:ram::123456789012****:role/AliyunRdsInstanceEncryptionDefaultRole

例

成功レスポンス

JSONJSON

{
  "DeleteDate": "2021-09-24T18:22:03Z",
  "RequestId": "9A931CE5-C926-5E09-B0EC-6299C4A6****",
  "Description": "testkey",
  "Origin": "Aliyun_KMS",
  "MaterialExpireTime": "2021-09-24T18:22:03Z",
  "EncryptionKeyStatus": "Enabled",
  "KeyUsage": "ENCRYPT/DECRYPT",
  "EncryptionKey": "ad463061-992d-4195-8a94-ed63********",
  "Creator": "17649847********",
  "EncryptionName": "AES-CTR-256",
  "RoleArn": "acs:ram::123456789012****:role/AliyunRdsInstanceEncryptionDefaultRole"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InstanceType.NotSupport	Current instance type does not support this operation.

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

変更履歴

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