DescribeKeyVersion - 查询指定密钥版本信息_密钥管理服务(KMS)-阿里云帮助中心

查询指定密钥版本信息。

接口说明

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	密钥 ID。如果请求中的 KeyId 参数使用的是密钥别名、密钥 ARN，在响应中也会返回密钥 ID。	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.	-

访问错误中心查看更多错误码。