接口功能介绍
查询主密钥的所有版本
接口约束
请保证账户余额大于0
URI
POST /v1/versionControl/listKeyVersions
路径参数
无
Query参数
无
请求参数
请求头header参数
请参见请求消息头
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| cmkUuid | 是 | String | 密钥唯一标识id | 474e569e-8814-474a-948b-dbcf6d853eff | |
| pageNumber | 是 | String | 当前页数 | 1 | |
| pageSize | 是 | String | 每页展示的版本数量 | 10 |
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| code | 是 | String | 返回码，取值范围： 200：成功 400：参数缺失或错误 401：用户验证错误 404：操作目标不可用 500：系统内部错误 |
200 | |
| errorCode | 是 | String | 错误码 | KMS.0514 | |
| msg | 是 | String | 调用结果信息 | 获取密钥版本信息成功 | |
| data | 是 | Object | 接口返回结果 | returnObj |
表 returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| pageNumber | 是 | String | 当前页数 | 1 | |
| pageSize | 是 | String | 每页数据数量 | 10 | |
| content | 是 | List | 密钥版本id | contentList | |
| totalCount | 是 | int | 数据总数 | 10 |
表 contentList
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| cmkUuid | 是 | String | 密钥唯一标识id | 474e569e-8814-474a-948b-dbcf6d853eff | |
| primaryKeyVersion | 是 | String | 密钥版本id | 474e569e-8814-474a-948b-dbcf6d853eff | |
| updatedAt | 是 | String | 版本创建时间 | 2021-05-17 19:32:58 |
请求示例
请求头header
{
"Content-Type": "application/json",
"requestDate": "20221101T154654Z",
"ctyun-eop-request-id": "89bf1559-a96e-4bc9-98fc-394d169a42e4",
"Eop-Authorization":"91ef73a6329545c294be1d5c763bdf7e Headers=ctyun-eop-request-id;eop-date Signature=2mc3zggaqLEGTSVy2H8lWsFEm+BNJf0CrcomDSOxPfc=",
"regionId":"60a39fca876e11ea91cf0242ac110002"
}
请求体body
{
"cmkUuid": "70b4d747-abc2-471b-abea-622daf112d41",
"pageNumber": "1",
"pageSize": "10",
}
响应示例
{
"code": "200",
"errorCode": null,
"msg": "获取密钥版本信息成功",
"data": {
"content": [
{
"cmkUuid": "28d7ccf6-5524-49f5-a146-c7e93c437f4e",
"primaryKeyVersion": "48f4ba45-0192-454a-8d43-eb788f131641",
"updatedAt": "2021-05-17 19:32:58",
}
],
"pageSize ": "1",
"pageNumber":"10",
"totalCount":"1"
}
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功。 |
| 400 | 表示参数缺失或错误。 |
| 401 | 表示用户验证错误。 |
| 404 | 表示操作目标不可用。 |
| 500 | 表示系统内部错误。 |
错误码
请参考 错误码说明。
