ListKeyVersions - 列出主密钥的所有密钥版本_密钥管理服务(KMS)-阿里云帮助中心

列出主密钥的所有密钥版本。

接口说明

RAM 用户或 RAM 角色调用该 OpenAPI 需要被授予的权限策略详情，请参见访问控制。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
KeyId	string	是	密钥的 ID，也可以指定为密钥别名或密钥资源名称（ARN）。关于别名的详细介绍，请参见管理密钥别名。说明访问其他阿里云账号下的密钥时，必须输入密钥 ARN。密钥 ARN 的格式为`acs:kms:${region}:${account}:key/${keyid}`。	key-hzz630494463ejqjx****
PageNumber	integer	是	当前页数。取值为大于 0 的整数。默认值：1。	1
PageSize	integer	否	每页返回的结果个数。取值范围：0~101。默认值：10。	10

返回参数

名称	类型	描述	示例值
	object
PageSize	integer	每页的返回结果个数。	10
RequestId	string	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。	f71204c4-53cd-4eea-b405-653ba2db7e86
PageNumber	integer	当前页数。	1
TotalCount	integer	返回的密钥版本总数。	3
KeyVersions	array<object>	返回的密钥版本数组。
KeyVersion	object	返回的密钥版本数组。
KeyId	string	密钥 ID。如果请求中的 KeyId 参数使用的是密钥别名、密钥 ARN，在响应中也会返回密钥 ID。	key-hzz630494463ejqjx****
KeyVersionId	string	密钥版本的全局唯一标识符。	1e3304fd-68ac-4d5b-8886-ae5f01a1****
CreationDate	string	创建密钥版本时的日期和时间（UTC 时间）。	2024-03-25T10:42:40Z

示例

正常返回示例

JSON格式

{
  "PageSize": 10,
  "RequestId": "f71204c4-53cd-4eea-b405-653ba2db7e86",
  "PageNumber": 1,
  "TotalCount": 3,
  "KeyVersions": {
    "KeyVersion": [
      {
        "KeyId": "key-hzz630494463ejqjx****",
        "KeyVersionId": "1e3304fd-68ac-4d5b-8886-ae5f01a1****",
        "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.	-
404	Forbidden.KeyNotFound	The specified Key is not found.	指定的密钥不存在。

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