全部產品
Search

搜尋本產品

    ApsaraDB for MongoDB：DescribeUserEncryptionKeyList - 查詢執行個體的自訂密鑰列表

    文件中心

    ApsaraDB for MongoDB：DescribeUserEncryptionKeyList - 查詢執行個體的自訂密鑰列表

    更新時間：Apr 21, 2026

    查詢執行個體的自訂密鑰列表。

    介面說明

    使用通過 DescribeUserEncryptionKeyList 查詢到的自訂密鑰可以開啟透明資料加密 TDE。詳細資料請參見 ModifyDBInstanceTDE 。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    dds:DescribeUserEncryptionKeyList

    get

    *dbinstance

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

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    DBInstanceId

    string

    是

    執行個體 ID。

    dds-bpxxxxxxxx
    TargetRegionId

    string

    否

    目標可用性區域 ID，您可以通過 DescribeRegions 查詢可用的可用性區域。

    cn-shanghai
    RoleARN

    string

    否

    指定角色的 ARN。格式：acs:ram::$accountID:role/$roleName ，預設值為：acs:ram::$accountID:role/aliyunrdsinstanceencryptiondefaultrole。

    說明

    • $accountID：雲帳號 ID。您可以通過登入阿里雲控制台，將滑鼠移至上方在右上方頭像的位置，單擊安全設定進行查看。

    • $roleName：RAM 角色名稱。您可以通過登入 RAM 控制台，單擊左側導覽列的 RAM 角色管理，在 RAM 角色名稱列表下進行查看。

    acs:ram::123456789012****:role/aliyunrdsinstanceencryptiondefaultrole

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    RequestId

    string

    請求 ID。

    7CD51DA4-A499-43CE-B9B5-20CD4FDC648E
    KeyIds

    object

    KeyId

    array

    執行個體密鑰列表。

    string

    執行個體密鑰。

    2a4f4ac2-xxxx-xxxx-xxxx-xxxxxxxxxxxx

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "7CD51DA4-A499-43CE-B9B5-20CD4FDC648E",
  "KeyIds": {
    "KeyId": [
      "2a4f4ac2-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    ]
  }
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    403 INVALID_INSNAME_REGIONID_EMPTY The insName and regionId can't be all empty

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

    變更歷史

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