全部產品
Search
文件中心

:DescribeUserEncryptionKeyList - 查詢執行個體自訂密鑰列表

更新時間:Jan 16, 2026

查看KMS密鑰列表。

調試

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

調試

授權資訊

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

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

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

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

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

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

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

polardb:DescribeUserEncryptionKeyList

get

*DBCluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}

請求參數

名稱

類型

必填

描述

樣本值

PageSize

integer

分頁大小

30

PageNumber

integer

頁碼

1

DBClusterId

string

叢集 ID。

說明

您可以調用 DescribeDBClusters 介面查看目標地區下所有的叢集資訊,包括叢集 ID。

pc-************

RegionId

string

地區 ID。

說明

您可以調用 DescribeRegions 介面查看目標帳號下的可用地區資訊,包括地區 ID。

cn-hangzhou

TDERegion

string

TDE 密鑰所在地區。

cn-beijing

返回參數

名稱

類型

描述

樣本值

object

RequestId

string

請求 ID。

A7E6A8FD-C50B-46B2-BA85-D8B8D3******

KeyList

array

叢集密鑰列表。

string

密鑰列表。

0275bd3f-fdbb-4d8c-846b-71b211******

TotalRecordCount

integer

總記錄數量

1

PageRecordCount

integer

當前頁記錄數量

1

PageNumber

integer

頁碼

1

PageSize

integer

分頁大小

30

DBClusterId

string

叢集 ID。

pc-************

樣本

正常返回樣本

JSON格式

{
  "RequestId": "A7E6A8FD-C50B-46B2-BA85-D8B8D3******",
  "KeyList": [
    "0275bd3f-fdbb-4d8c-846b-71b211******"
  ],
  "TotalRecordCount": 1,
  "PageRecordCount": 1,
  "PageNumber": 1,
  "PageSize": 30,
  "DBClusterId": "pc-************"
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

400 ByokRoleArnNotFound The roleArn can't be null.
401 ByokNotAuthorizedToRds This user is not Authorized Rds. 此使用者未經Rds授權。
403 UnsupportedKmsService.NotEnabled KMS service is not enabled. 未啟用KMS服務。
404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. 當前的記錄中不存在提供的DBClusterId。
404 InvalidDBClusterId.NotFound The DBClusterId provided does not exist in our records. 當前的記錄中不存在提供的 DBClusterId。
404 InvalidDBClusterId.Malformed The specified parameter DBClusterId is not valid. 指定的參數DBClusterId無效

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

變更歷史

更多資訊,參考變更詳情