查詢云數據庫 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 | *全部資源 * |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 是 | 實例 ID,可調用 DescribeInstances 獲取。 | r-bp1zxszhcgatnx**** |
EncryptionKey | string | 否 | 實例的自定義密鑰 ID,可調用 DescribeEncryptionKeyList 接口查詢。 | ad463061-992d-4195-8a94-ed63******** |
返回參數
示例
正常返回示例
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. | 當前實例類型不支持此操作 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-02-26 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發生變更 | 查看變更詳情 |