全部產品
Search
文件中心

Key Management Service:ListKeys - 查詢調用者在調用地區的所有主要金鑰ID

更新時間:Aug 21, 2025

查詢調用者在調用地區的所有主要金鑰ID。

介面說明

RAM 使用者或 RAM 角色調用該 OpenAPI 需要被授與權限策略詳情,請參見存取控制

調試

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

調試

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱

類型

必填

描述

樣本值

PageNumber

integer

當前頁數。
取值範圍:大於 0。
預設值:1。




1

PageSize

integer

每頁傳回值的個數。
取值範圍:1~100。
預設值:10。




10

Filters

string

主要金鑰過濾器。由 Key-Values 索引值對組成,長度為 0~10。

  • Key
    • 描述:需要過濾的屬性。

    • 類型:String。

  • Values
    • 描述:期望過濾後包含的值。

    • 類型:String 數組。

    • 長度:0~10。

取值:

  • Key 取值為 KeyState 時表示密鑰狀態。Vaule 取值為 Enabled(啟用)、Disabled(禁用)、PendingDeletion(待刪除)或 PendingImport(待匯入)。

  • Key 取值為 KeySpec 時表示密鑰類型。Vaule 取值為 Aliyun_AES_256、Aliyun_SM4、RSA_2048、EC_P256、EC_P256K、EC_SM2、Aliyun_SM4。
    說明:僅在支援託管密碼機且已通過國密局商用密碼檢測認證的地區可以建立 EC_SM2 和 Aliyun_SM4 類型的密鑰,地區詳情請參見支援的地區。如果您所選擇地區不支援 EC_SM2 和 Aliyun_SM4,指定這兩個參數將被忽略。

  • Key 取值為 KeyUsage 時表示密鑰用途。Vaule 取值為 ENCRYPT/DECRYPT(資料加密和解密)、SIGN/VERIFY (產生和驗證數位簽章)。

  • Key 取值為 ProtectionLevel 時表示密鑰保護等級。Vaule 取值為 SOFTWARE(軟體)、HSM(硬體)。
    說明:HSM 保護等級僅在特定地區支援,地區詳情請參見支援的地區。如您所選擇地區不支援 HSM,指定該參數將被忽略。

  • Key 取值為 CreatorType 時表示建立者類型。Vaule 取值為 User(擷取由使用者建立的主要金鑰)、Service (擷取由使用者授權其他雲產品自動建立的主要金鑰)。

  • Key 取值為 DKMSInstanceId 時表示 KMS 執行個體 ID。Vaule 請按照實際填寫。

  • Key 取值為 keyId 時表示金鑰識別碼。Vaule 請按照實際填寫。

  • Key 取值為 AliasName 時表示密鑰別名。Vaule 請按照實際填寫。

  • Key 取值為 Creator 時表示密鑰建立者。Vaule 請按照實際填寫。

  • Key 取值為 TagKey 時表示密鑰標籤中的 Key。Vaule 請按照實際填寫。

  • Key 取值為 TagValue 時表示密鑰標籤中的 Value。Vaule 請按照實際填寫。

Filters 不同 Key 之間的邏輯關係為 AND,同一個 Key 中的多個 Value 之間的邏輯關係為 OR。例如:輸入 [ {"Key":"KeyState", "Values":["Enabled","Disabled"]}, {"Key":"KeyState", "Values":["PendingDeletion"]}, {"Key":"KeySpec", "Values":["Aliyun_AES_256"]} ] 時,語義為: (KeyState=Enabled OR KeyState=Disabled OR KeyState=PendingDeletion) AND (KeySpec=Aliyun_AES_256)。

[{"Key":"KeyState", "Values":["Enabled","Disabled"]}]

返回參數

名稱

類型

描述

樣本值

object

PageNumber

integer

當前頁數。

1

PageSize

integer

每頁傳回值的個數。

10

RequestId

string

本次調用請求的 ID,是由阿里雲為該請求產生的唯一識別碼,可用於排查和定位問題。

8252db58-2036-408c-a3d5-56e656dc2551

TotalCount

integer

主要金鑰的總數。

3

Keys

object

Key

array<object>

主要金鑰。

object

主要金鑰。

KeyId

string

主要金鑰的通用唯一識別碼。

08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****

KeyArn

string

主要金鑰的 ARN。

acs:kms:cn-hangzhou:123456:key/80e9409f-78fa-42ab-84bd-83f40c81****

樣本

正常返回樣本

JSON格式

{
  "PageNumber": 1,
  "PageSize": 10,
  "RequestId": "8252db58-2036-408c-a3d5-56e656dc2551",
  "TotalCount": 3,
  "Keys": {
    "Key": [
      {
        "KeyId": "08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****",
        "KeyArn": "acs:kms:cn-hangzhou:123456:key/80e9409f-78fa-42ab-84bd-83f40c81****"
      }
    ]
  }
}

錯誤碼

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

變更歷史

更多資訊,參考變更詳情