ListKeys - - 阿里雲

調試

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

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	ListKeys	要執行的操作。取值：ListKeys。
PageNumber	Integer	否	1	當前頁數。取值範圍：大於0。預設值：1。
PageSize	Integer	否	10	每頁傳回值的個數。取值範圍：1~100。預設值：10。
Filters	String	否	[{"Key":"KeyState", "Values":["Enabled","Disabled"]}]	主要金鑰過濾器。由Key-Values索引值對組成，長度為0~10。 Key 描述：需要過濾的屬性。類型：String。取值： KeyState：密鑰狀態。 KeySpec：密鑰類型。 KeyUsage：密鑰用途。 ProtectionLevel：保護等級。 CreatorType：建立者類型。 DKMSInstanceId：KMS執行個體的執行個體ID。 Values 描述：期望過濾後包含的值。類型：String數組。長度：0~10。取值： Key取值為KeyState時：Enabled（啟用）、Disabled（禁用）、PendingDeletion（待刪除）、PendingImport（待匯入）。 Key取值為KeySpec時：Aliyun_AES_256、Aliyun_SM4、RSA_2048、EC_P256、EC_P256K、EC_SM2。說明：僅在支援託管密碼機且已通過國密局商用密碼檢測認證的地區可以建立EC_SM2和Aliyun_SM4類型的密鑰，地區詳情請參見支援的地區。如果您所選擇地區不支援EC_SM2和Aliyun_SM4，指定這兩個參數將被忽略。 Key取值為KeyUsage時：ENCRYPT/DECRYPT（資料加密和解密）、SIGN/VERIFY （產生和驗證數位簽章）。 Key取值為ProtectionLevel時：SOFTWARE（軟體）、HSM（硬體）。說明：HSM保護等級僅在特定地區支援，地區詳情請參見支援的地區。如您所選擇地區不支援HSM，指定該參數將被忽略。 Key取值為CreatorType時：User（擷取由使用者建立的主要金鑰）、Service （擷取由使用者授權其他雲產品自動建立的主要金鑰）。 Key取值為DKMSInstanceId時：kst-xxx（KMS執行個體的執行個體ID）。 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)。`

返回資料

名稱	類型	樣本值	描述
PageNumber	Integer	1	當前頁數。
PageSize	Integer	10	每頁傳回值的個數。
RequestId	String	8252db58-2036-408c-a3d5-56e656dc2551	本次調用請求的ID，是由阿里雲為該請求產生的唯一識別碼，可用於排查和定位問題。
TotalCount	Integer	3	主要金鑰的總數。
Keys	Array of Key		主要金鑰。
Key
KeyId	String	08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****	主要金鑰的通用唯一識別碼。
KeyArn	String	acs:kms:cn-hangzhou:123456:key/80e9409f-78fa-42ab-84bd-83f40c81****	主要金鑰的ARN。

樣本

請求樣本

http(s)://[Endpoint]/?Action=ListKeys
&PageNumber=1
&PageSize=10
&Filters=[{"Key":"KeyState", "Values":["Enabled","Disabled"]}]
&公用請求參數

正常返回樣本

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

錯誤碼

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