批量查询密钥信息
更新时间 2025-09-19 14:45:59
最近更新时间: 2025-09-19 14:45:59
接口功能介绍
批量查询密钥信息
接口约束
请保证账户余额大于0
URI
POST /v1/keyManage/listAliasKeys
路径参数 无
Query参数 无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池id | fecnjniakfkn2314ndekqldedcsadfg |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| pageNumber | 是 | String | 页数 | 1 | |
| pageSize | 是 | String | 每页展示的别名数量 | 10 | |
| keyUsage | 否 | String | 密钥用途 | 1 | |
| status | 否 | String | 密钥状态 | 1 | |
| protectionLevel | 否 | String | 密钥保护级别 | 1 | |
| keySpec | 否 | String | 密钥类型 | AES_256 | |
| instanceId | 否 | String | 实例Id，非必传，当为空时列出所有密钥，不为空时列出指定实例下的密钥 | ins-1k7gy |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | String | 返回码 取值范围：200 成功 | 200 | |
| error | String | 错误码 | KMS_0514 | |
| message | String | 调用结果信息 | 获取密钥列表成功 | |
| returnObj | Object | 接口返回结果 | returnObj | |
| 表 returnObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| totalCount | String | 别名总数 | 100 | |
| pageSize | String | 每页展示的别名数量 | 10 | |
| pageNumber | String | 页数 | 1 | |
| content | Array of Strings | 密钥信息列表 | content | |
| 表 content |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| deletedTime | String | 密钥删除时间 | Tue Oct 25 15:06:52 CST 2022 | |
| rotationInterval | String | 轮转周期 | 7d | |
| nextRotationDate | String | 下次轮转时间 | Tue Oct 25 15:06:52 CST 2022 | |
| createdTime | String | 密钥创建时间 | Tue Oct 25 15:06:52 CST 2022 | |
| description | String | 密钥描述 | 密钥描述，长度小于8129 | Tue Oct 25 15:06:52 CST 2022 |
| cmkUuid | String | 密钥唯一标识 | 474e569e-8814-474a-948b-dbcf6d853eff | |
| status | String | 密钥状态 | 1 | |
| keyUsage | String | 密钥类型1-加密解密 2-签名验签 | 1 | |
| lastRotationDate | String | 上一次轮转时间 | Tue Oct 25 15:06:52 CST 2022 | |
| userId | String | 密钥所属用户id | 562b89493b1a40e1b97ea05e50dd8170 | |
| protectionLevel | String | 密钥保护级别 | 保护等级，0为硬件，1为软件 | |
| origin | String | 密钥来源 1-KMS 2-外部密钥 | 1 | |
| automaticRotation | String | 是否开启轮转取值0，1，2 | 1 | |
| isDefault | String | 密钥是否为默认密钥 | 1 | |
| keySpec | String | 密钥类型 | AES_256 | |
| aliasName | String | 密钥别名 | ECS | |
| regionId | String | 资源池id | fecnjniakfkn2314ndekqldedcsadfg | |
| updatedTime | String | 密钥更新时间 | 2022-10-25 15:06:53 |
枚举参数
无
请求示例
请求url
无
请求头header
{ "hmac": "B1uAGreROOnfuQkNp9I5bE4aXsGwBcL5daW3W0nL0Mw=", "requestDate": "Wed, 29 Aug 2023 17:05:01 CST", "accessKey": "ae2cc5cc5e8211ea978a186590d96509", "userId":"562b89493b1a40e1b97ea05e50dd8170", "regionId":"fecnjniakfkn2314ndekqldedcsadfg"}
请求体body
{ "pageNumber":"1", "pageSize":"10", "status":"1"}
响应示例
{ "statusCode": "200", "message": "获取密钥列表成功", "returnObj": { "content": [ { "cmkUuid": "474e569e-8814-474a-948b-dbcf6d853eff", "userId": "1123", "origin": 1, "protectionLevel": 1, "automaticRotation": 1, "rotationinTerval": null, "createdTime": "2022-10-25 15:06:53", "keyUsage": 1, "status": 1, "regionId": "123", "description": "", "keySpec": "AES_256", "nextRotationDate": null, "deletedTime": null, "updatedTime": "2022-10-25 15:06:53", "lastRotationDate": "2022-10-25 15:06:53", "isDefault": 0, "aliasName": "tdesdt_ali1adddddadcccdsasdas" } ], "pageNumber": 1, "pageSize": 10, "totalCount": 1 }}
状态码
请参考 状态码
错误码
请参考 错误码
