調用DescribeKeyVersion介面查詢指定密鑰版本資訊。
本文將提供一個樣本,為您查詢密鑰key-hzz630494463ejqjx****
的密鑰版本資訊,密鑰版本ID為2ab1a983-7072-4bbc-a582-584b5bd8****。返回結果顯示,密鑰版本的建立時間為2024-03-25T10:42:40Z。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
請求參數
|
名稱 |
類型 |
是否必選 |
樣本值 |
描述 |
| Action | String | 是 | DescribeKeyVersion | 要執行的操作。取值:DescribeKeyVersion。 |
| KeyId | String | 是 | key-hzz630494463ejqjx**** | 密鑰的ID,也可以指定為密鑰別名或密鑰資源名稱(ARN)。關於別名的詳細介紹,請參見管理密鑰別名。 說明 訪問其他阿里雲帳號下的密鑰時,必須輸入密鑰ARN。密鑰ARN的格式為 acs:kms:${region}:${account}:key/${keyid}。 |
| KeyVersionId | String | 是 | 2ab1a983-7072-4bbc-a582-584b5bd8**** | 密鑰版本的通用唯一識別碼。 您可以調用ListKeyVersions介面,擷取KeyVersionId。 |
關於公用請求參數的詳情,請參見公用參數。
返回資料
名稱 |
類型 |
樣本值 |
描述 |
| RequestId | String | 7021b6ec-4be7-4d3c-8a68-1e85d4d515a0 | 本次調用請求的ID,是由阿里雲為該請求產生的唯一識別碼,可用於排查和定位問題。 |
| KeyVersion | Object | 密鑰版本的中繼資料。 |
|
| KeyId | String | key-hzz630494463ejqjx**** | 密鑰ID。如果請求中的KeyId參數使用的是密鑰別名、密鑰ARN,在響應中也會返回密鑰ID。 |
| KeyVersionId | String | 2ab1a983-7072-4bbc-a582-584b5bd8**** | 密鑰版本的通用唯一識別碼。 |
| CreationDate | String | 2024-03-25T10:42:40Z | 建立密鑰版本時的日期和時間(UTC時間)。 |
樣本
請求樣本
http(s)://[Endpoint]/?Action=DescribeKeyVersion
&KeyId=key-hzz630494463ejqjx****
&KeyVersionId=2ab1a983-7072-4bbc-a582-584b5bd8****
&公用請求參數
正常返回樣本
XML格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeKeyVersionResponse>
<RequestId>7021b6ec-4be7-4d3c-8a68-1e85d4d515a0</RequestId>
<KeyVersion>
<KeyId>key-hzz630494463ejqjx****</KeyId>
<KeyVersionId>2ab1a983-7072-4bbc-a582-584b5bd8****</KeyVersionId>
<CreationDate>2024-03-25T10:42:40Z</CreationDate>
</KeyVersion>
</DescribeKeyVersionResponse>
JSON格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "7021b6ec-4be7-4d3c-8a68-1e85d4d515a0",
"KeyVersion" : {
"KeyId" : "key-hzz630494463ejqjx****",
"KeyVersionId" : "2ab1a983-7072-4bbc-a582-584b5bd8****",
"CreationDate" : "2024-03-25T10:42:40Z"
}
}
錯誤碼
|
HttpCode |
錯誤碼 |
錯誤資訊 |
描述 |
| 400 | InvalidParameter | The specified parameter is not valid. | 參數非法。 |
訪問錯誤中心查看更多錯誤碼。