調用ListKeyVersions介面列出主要金鑰的所有密鑰版本。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
請求參數
|
名稱 |
類型 |
是否必選 |
樣本值 |
描述 |
| Action | String | 是 | ListKeyVersions | 要執行的操作。取值:ListKeyVersions。 |
| KeyId | String | 是 | key-hzz630494463ejqjx**** | 密鑰的ID,也可以指定為密鑰別名或密鑰資源名稱(ARN)。關於別名的詳細介紹,請參見管理密鑰別名。 說明 訪問其他阿里雲帳號下的密鑰時,必須輸入密鑰ARN。密鑰ARN的格式為 acs:kms:${region}:${account}:key/${keyid}。 |
| PageNumber | Integer | 是 | 1 | 當前頁數。 取值為大於0的整數。 預設值:1。 |
| PageSize | Integer | 否 | 10 | 每頁返回的結果個數。 取值範圍:0~101。 預設值:10。 |
返回資料
名稱 |
類型 |
樣本值 |
描述 |
| PageSize | Integer | 10 | 每頁的返回結果個數。 |
| RequestId | String | f71204c4-53cd-4eea-b405-653ba2db7e86 | 本次調用請求的ID,是由阿里雲為該請求產生的唯一識別碼,可用於排查和定位問題。 |
| PageNumber | Integer | 1 | 當前頁數。 |
| TotalCount | Integer | 3 | 返回的密鑰版本總數。 |
| KeyVersions | Array of KeyVersion | 返回的密鑰版本數組。 |
|
| KeyVersion | |||
| KeyId | String | key-hzz630494463ejqjx**** | 密鑰ID。如果請求中的KeyId參數使用的是密鑰別名、密鑰ARN,在響應中也會返回密鑰ID。 |
| KeyVersionId | String | 1e3304fd-68ac-4d5b-8886-ae5f01a1**** | 密鑰版本的通用唯一識別碼。 |
| CreationDate | String | 2024-03-25T10:42:40Z | 建立密鑰版本時的日期和時間(UTC時間)。 |
樣本
請求樣本
http(s)://[Endpoint]/?Action=ListKeyVersions
&KeyId=key-hzz630494463ejqjx****
&PageNumber=1
&PageSize=10
&公用請求參數
正常返回樣本
XML格式
HTTP/1.1 200 OK
Content-Type:application/xml
<ListKeyVersionsResponse>
<PageSize>10</PageSize>
<RequestId>f71204c4-53cd-4eea-b405-653ba2db7e86</RequestId>
<PageNumber>1</PageNumber>
<TotalCount>3</TotalCount>
<KeyVersions>
<KeyId>key-hzz630494463ejqjx****</KeyId>
<KeyVersionId>1e3304fd-68ac-4d5b-8886-ae5f01a1****</KeyVersionId>
<CreationDate>2024-03-25T10:42:40Z</CreationDate>
</KeyVersions>
</ListKeyVersionsResponse>
JSON格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"PageSize" : 10,
"RequestId" : "f71204c4-53cd-4eea-b405-653ba2db7e86",
"PageNumber" : 1,
"TotalCount" : 3,
"KeyVersions" : [ {
"KeyId" : "key-hzz630494463ejqjx****",
"KeyVersionId" : "1e3304fd-68ac-4d5b-8886-ae5f01a1****",
"CreationDate" : "2024-03-25T10:42:40Z"
} ]
}
錯誤碼
|
HttpCode |
錯誤碼 |
錯誤資訊 |
描述 |
| 400 | InvalidParameter | The specified parameter is not valid. | 參數非法。 |
| 404 | Forbidden.KeyNotFound | The specified Key is not found. | 指定的密鑰不存在。 |
訪問錯誤中心查看更多錯誤碼。