批量查询密钥信息
更新时间 2026-03-12 13:57:18
最近更新时间: 2026-03-12 13:57:18
接口功能介绍
批量查询密钥信息
接口约束
请保证账户余额大于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 | |
| epId | 否 | Array of Strings | 企业项目id列表 | default | |
| cmkuuidList | 否 | Array of Strings | 密钥id列表 | ||
| 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 | |
| requestId | String | 请求id | 1495cff0-b58a-44da-b10b-8ed47d91de89 | |
| 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 | |
| updatedTime | String | 密钥更新时间 | 2022-10-25 15:06:53 | |
| epId | String | 企业项目id | default | |
| deleted | String | 密钥是否删除（0-未删除，1-已删除） | 0 |
枚举参数
无
请求示例
请求url
无
请求头header
{
"regionId": "fecnjniakfkn2314ndekqldedcsadfg"
}
请求体body
{
"pageNumber": "1",
"pageSize": "10",
"instanceId": ""
}
响应示例
{
"statusCode": "200",
"message": "获取密钥列表成功",
"returnObj": {
"requestId": "4fa9cdcf-fc4e-46ab-ac2f-70f37caf3033",
"content": [
{
"cmkUuid": "4fa4750e-53c9-4411-8d88-f49edf106589",
"userId": "c07960e2659b486e8d48ab7e6022645d",
"origin": 1,
"protectionLevel": 1,
"automaticRotation": 0,
"rotationinTerval": "604800",
"createdTime": "2025-10-22 15:59:07",
"keyUsage": 1,
"status": 1,
"description": "描述",
"keySpec": "AES_256",
"nextRotationDate": "2025-10-29 15:59:07",
"deletedTime": null,
"updatedTime": "2025-10-23 01:13:19",
"lastRotationDate": "2025-10-22 15:59:07",
"isDefault": 0,
"aliasName": "2025-10-20 10:13:44.248036",
"epId": default,
"deleted": 0
}
],
"pageNumber": 1,
"pageSize": 10,
"totalCount": 1
}
}
状态码
请参考 状态码
错误码
请参考 错误码
