查询用户所有密钥别名
更新时间 2026-03-12 13:58:00
最近更新时间: 2026-03-12 13:58:00
接口功能介绍
查询密钥别名
接口约束
请保证账户余额大于0
URI
POST /v1/keyName/listAlias
路径参数 无
Query参数 无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池id | fecnjniakfkn2314ndekqldedcsadfg |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| pageNumber | 是 | String | 页数 | 1 | |
| pageSize | 是 | String | 每页展示的别名数量 | 10 | |
| instanceId | 否 | String | 实例Id，非必传，当为空时列出所有别名，不为空时列出指定实例下的别名 | ins-X63C8r |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | String | 返回码 取值范围：200 成功 | 200 | |
| error | String | 错误码 | KMS_0514 | |
| message | String | 调用结果信息 | 查询成功 | |
| returnObj | Object | 接口返回结果 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| totalCount | String | 别名总数 | 100 | |
| requestId | String | 请求id | 1d6d65ac-761d-4276-ad0f-1b94ef2ea29d | |
| pageSize | String | 每页展示的别名数量 | 10 | |
| pageNumber | String | 页数 | 1 | |
| aliases | String | 别名信息 | aliases |
表 aliases
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| alias | Array of Strings | 别名信息 | aliasList |
表 aliasList
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| aliasName | String | 别名 | addqweqwsd | |
| cmkUuid | String | 密钥id | 00f57b81-91d5-4b65-9007-6195528f8a37 |
枚举参数
无
请求示例
请求url
无
请求头header
{
"regionId": "200000001852"
}
请求体body
{
"pageNumber": "1",
"pageSize": "10",
"instanceId": ""
}
响应示例
{
"statusCode": "200",
"message": "获取别名列表成功",
"returnObj": {
"requestId": "11de2baf-9f76-4528-8844-2d197b0cad47",
"aliases": {
"alias": [
{
"aliasName": "2025-10-20 10:13:44.248036",
"cmkUuid": "4fa4750e-53c9-4411-8d88-f49edf106589"
},
{
"aliasName": "2025-10-21 09:49:29.153225",
"cmkUuid": "4fa4750e-53c9-4411-8d88-f49edf106589"
}
]
},
"pageNumber": "1",
"pageSize": "10",
"totalCount": 2
}
}
状态码
请参考 状态码
错误码
请参考 错误码
