文档

DescribeKeyVersion

更新时间:

调用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. 参数非法。

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