查詢MongoDB實(shí)例的某個(gè)密鑰的詳情。
接口說(shuō)明
調(diào)用 DescribeDBInstanceEncryptionKey 接口時(shí)，實(shí)例必須以 BYOK 的方式開(kāi)啟了透明數(shù)據(jù)加密 TDE。您可以調(diào)用 ModifyDBInstanceTDE 來(lái)開(kāi)啟 TDE。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對(duì)應(yīng)的授權(quán)信息，可以在RAM權(quán)限策略語(yǔ)句的Action元素中使用，用來(lái)給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說(shuō)明如下：
- 操作：是指具體的權(quán)限點(diǎn)。
- 訪問(wèn)級(jí)別：是指每個(gè)操作的訪問(wèn)級(jí)別，取值為寫(xiě)入（Write）、讀取（Read）或列出（List）。
- 資源類(lèi)型：是指操作中支持授權(quán)的資源類(lèi)型。具體說(shuō)明如下：
- 對(duì)于必選的資源類(lèi)型，用背景高亮的方式表示。
- 對(duì)于不支持資源級(jí)授權(quán)的操作，用
全部資源表示。
- 條件關(guān)鍵字：是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作：是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限，操作才能成功。
| 操作 | 訪問(wèn)級(jí)別 | 資源類(lèi)型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
|---|---|---|---|---|
| dds:DescribeDBInstanceEncryptionKey | get |
|
| 無(wú) |
請(qǐng)求參數(shù)
| 名稱 | 類(lèi)型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DBInstanceId | string | 是 | 實(shí)例 ID。 | dds-bp2235**** |
| EncryptionKey | string | 否 | 可以輸入一個(gè)實(shí)例自定義密鑰。您可以調(diào)用 DescribeUserEncryptionKeyList 查詢實(shí)例的自定義密鑰列表。 | 2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx |
返回參數(shù)
示例
正常返回示例
JSON格式
{
"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"
}錯(cuò)誤碼
| HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 |
|---|---|---|
| 403 | INVALID_INSNAME_REGIONID_EMPTY | The insName and regionId can't be all empty |
| 403 | NO_ACTIVE_BYOK | This custins no active byok. |
訪問(wèn)錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
| 變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
|---|
暫無(wú)變更歷史