DescribeEncryptionKey - 查詢執行個體的TDE自訂密鑰詳情 - Tair (Redis® OSS-Compatible)

查詢雲資料庫 Tair（相容 Redis）執行個體的透明資料加密TDE自訂密鑰的詳情。

介面說明

調用本介面時，要求執行個體已通過自訂密鑰的方式開啟了資料加密 TDE（Transparent Data Encryption）功能，相關介面，請參見 ModifyInstanceTDE 。

說明

關於透明資料加密 TDE 的詳細介紹及注意事項，請參見開啟透明資料加密 TDE。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

kvstore:DescribeEncryptionKey

get

*DBInstance

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

無

請求參數

名稱	類型	必填	描述	樣本值
InstanceId	string	是	執行個體 ID，可調用 DescribeInstances 擷取。	r-bp1zxszhcgatnx****
EncryptionKey	string	否	執行個體的自訂金鑰識別碼，可調用 DescribeEncryptionKeyList 介面查詢。	ad463061-992d-4195-8a94-ed63********

返回參數

名稱	類型	描述	樣本值
	object
DeleteDate	string	執行個體密鑰的預計刪除時間，格式為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，即表示阿里雲Key Management Service。	Aliyun_KMS
MaterialExpireTime	string	密鑰的到期時間，格式為yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。說明本參數返回內容為空白時，表示密鑰不會到期。	2021-09-24T18:22:03Z
EncryptionKeyStatus	string	執行個體的密鑰狀態，傳回值： Enabled：可用。 Disabled：不可用。	Enabled
KeyUsage	string	執行個體密鑰的用途，傳回值`ENCRYPT/DECRYPT`即表示加密和解密。	ENCRYPT/DECRYPT
EncryptionKey	string	執行個體的金鑰識別碼。	ad463061-992d-4195-8a94-ed63********
Creator	string	密鑰建立者的雲帳號 ID。	17649847********
EncryptionName	string	密碼編譯演算法。	AES-CTR-256
RoleArn	string	指定待授權角色的全域資源描述符 ARN（Alibaba Cloud Resource Name）資訊。	acs:ram::123456789012****:role/AliyunRdsInstanceEncryptionDefaultRole

樣本

正常返回樣本

JSON格式

{
  "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 status code	錯誤碼	錯誤資訊	描述
400	InstanceType.NotSupport	Current instance type does not support this operation.	當前執行個體類型不支援此操作

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。