全部產品
Search

搜尋本產品

    PolarDB：DescribeDBClusterEncryptionKey - 查詢PolarDB執行個體密鑰詳情

    文件中心

    PolarDB：DescribeDBClusterEncryptionKey - 查詢PolarDB執行個體密鑰詳情

    更新時間：Sep 18, 2025

    查詢指定PolarDB執行個體的密鑰使用詳情。

    介面說明

    請求說明

    • 該 API 用於擷取 PolarDB 執行個體的密鑰使用詳情，包括金鑰識別碼、狀態、類型等資訊。

    • DBClusterId參數是必需的，用於指定要查詢的 PolarDB 執行個體 ID。

    • 請確保在調用此介面前已經正確配置了相關的 RAM 角色和策略。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    polardb:DescribeDBClusterEncryptionKey

    get

    *全部資源

    *

    		 無 無

    請求文法

    POST  HTTP/1.1

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    ClientToken

    string

    否

    等冪參數

    6000170000591aed949d0f******************
    DBClusterId

    string

    否

    叢集 ID。

    說明

    您可以通過 DescribeDBClusters 介面查看帳號下所有叢集的詳細資料，包括叢集 ID。

    pc-***

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    Schema of Response

    RequestId

    string

    請求 ID。

    137ECCC0-920E-5B3B-9F8E-B81632108BBE
    EncryptionKeyList

    array<object>

    密鑰列表。

    object

    密鑰詳情。

    AliasName

    string

    密鑰別名。

    alias/your_default_key
    Creator

    string

    密鑰建立者主帳號的 UID。

    1****1
    DeleteDate

    string

    預計刪除密鑰時間。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。

    • 若您沒有標記密鑰刪除，該欄位為空白

    2026-05-08T08:14:16Z
    Description

    string

    密鑰描述。

    Description of the key
    EncryptionKey

    string

    金鑰識別碼。

    51858179-afb3-4369-8329-*********
    EncryptionKeyStatus

    string

    密鑰的狀態。傳回值：

    • Enabled：啟用。

    • Disabled：未啟用。

    Enabled
    KeyType

    string

    Key 的類型。傳回值說明：

    • CMK：使用者自訂密鑰

    • ServiceKey：服務密鑰

    ServiceKey
    KeyUsage

    string

    密鑰用途。

    ENCRYPT/DECRYPT
    MaterialExpireTime

    string

    密鑰到期時間。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。

    2025-10-18T08:14:16Z
    Origin

    string

    密鑰的來源。

    Aliyun_KMS
    UsedBy

    string

    密鑰的使用途徑：

    • TDE：透明資料加密。

    • DiskEncryption：雲端硬碟加密。

    DiskEncryption

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "137ECCC0-920E-5B3B-9F8E-B81632108BBE",
  "EncryptionKeyList": [
    {
      "AliasName": "alias/your_default_key",
      "Creator": "1****1",
      "DeleteDate": "2026-05-08T08:14:16Z",
      "Description": "Description of the key",
      "EncryptionKey": "51858179-afb3-4369-8329-*********",
      "EncryptionKeyStatus": "Enabled",
      "KeyType": "ServiceKey",
      "KeyUsage": "ENCRYPT/DECRYPT",
      "MaterialExpireTime": "2025-10-18T08:14:16Z",
      "Origin": "Aliyun_KMS",
      "UsedBy": "DiskEncryption"
    }
  ]
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 IdempotentParameterMismatch The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.
    404 InvalidDBClusterId.Malformed The specified parameter DBClusterId is not valid. 指定的參數DBClusterId無效
    404 InvalidDBClusterId.NotFound The DBInstanceId provided does not exist in our records. 當前的記錄中不存在提供的DBClusterId。
    404 InvalidDBInstance.NotFound The DBClusterId provided does not exist in our records. 我們的記錄中不存在提供的DBClusterId。

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

    變更歷史

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