文档

ListKeyVersions

更新时间:

调用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. 指定的密钥不存在。

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