全部產品
Search
文件中心

Key Management Service:DescribeKeyVersion - 查詢指定密鑰版本資訊

更新時間:Dec 21, 2025

查詢指定密鑰版本資訊。

介面說明

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

本文將提供一個樣本,為您查詢密鑰key-hzz630494463ejqjx**** 的密鑰版本資訊,密鑰版本 ID 為2ab1a983-7072-4bbc-a582-584b5bd8****。返回結果顯示,密鑰版本的建立時間為2024-03-25T10:42:40Z

調試

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

調試

授權資訊

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

請求參數

名稱

類型

必填

描述

樣本值

KeyId

string

密鑰的 ID,也可以指定為密鑰別名或密鑰資源名稱(ARN)。關於別名的詳細介紹,請參見管理密鑰別名

說明

訪問其他阿里雲帳號下的密鑰時,必須輸入密鑰 ARN。密鑰 ARN 的格式為acs:kms:${region}:${account}:key/${keyid}

key-hzz630494463ejqjx****

KeyVersionId

string

密鑰版本的通用唯一識別碼。
您可以調用 ListKeyVersions 介面,擷取 KeyVersionId。

2ab1a983-7072-4bbc-a582-584b5bd8****

關於公用請求參數的詳情,請參見公用參數

返回參數

名稱

類型

描述

樣本值

object

RequestId

string

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

7021b6ec-4be7-4d3c-8a68-1e85d4d515a0

KeyVersion

object

密鑰版本的中繼資料。

KeyId

string

金鑰識別碼。如果請求中的 KeyId 參數使用的是密鑰別名、密鑰 ARN,在響應中也會返回金鑰識別碼。

key-hzz630494463ejqjx****

KeyVersionId

string

密鑰版本的通用唯一識別碼。

2ab1a983-7072-4bbc-a582-584b5bd8****

CreationDate

string

建立密鑰版本時的日期和時間(UTC 時間)。

2024-03-25T10:42:40Z

樣本

正常返回樣本

JSON格式

{
  "RequestId": "7021b6ec-4be7-4d3c-8a68-1e85d4d515a0",
  "KeyVersion": {
    "KeyId": "key-hzz630494463ejqjx****",
    "KeyVersionId": "2ab1a983-7072-4bbc-a582-584b5bd8****",
    "CreationDate": "2024-03-25T10:42:40Z"
  }
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

400 InvalidParameter The specified parameter is not valid. 參數非法。
404 InvalidAccessKeyId.NotFound The Access Key ID provided does not exist in our records.

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

變更歷史

更多資訊,參考變更詳情