全部產品
Search

搜尋本產品

    ApsaraDB for MongoDB：DescribeDBInstanceEncryptionKey - 查詢MongoDB執行個體的某個密鑰的詳情

    文件中心

    ApsaraDB for MongoDB：DescribeDBInstanceEncryptionKey - 查詢MongoDB執行個體的某個密鑰的詳情

    更新時間：Dec 18, 2025

    查詢MongoDB執行個體的某個密鑰的詳情。

    介面說明

    調用 DescribeDBInstanceEncryptionKey 介面時，執行個體必須以 BYOK 的方式開啟了透明資料加密 TDE。您可以調用 ModifyDBInstanceTDE 來開啟 TDE。

    調試

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

    調試

    授權資訊

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

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    dds:DescribeDBInstanceEncryptionKey

    get

    *Instance

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

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    DBInstanceId

    string

    是

    執行個體 ID。

    dds-bp2235****
    EncryptionKey

    string

    否

    可以輸入一個執行個體自訂密鑰。您可以調用 DescribeUserEncryptionKeyList 查詢執行個體的自訂密鑰列表。

    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

    樣本

    正常返回樣本

    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"
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    403 INVALID_INSNAME_REGIONID_EMPTY The insName and regionId can't be all empty
    403 NO_ACTIVE_BYOK This custins no active byok.

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

    變更歷史

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