查询用户所有密钥别名
更新时间 2025-09-19 14:16:35
最近更新时间: 2025-09-19 14:16:35
接口功能介绍
查询密钥别名
接口约束
请保证账户余额大于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 | |
| 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
{ "hmac": "B1uAGreROOnfuQkNp9I5bE4aXsGwBcL5daW3W0nL0Mw=", "requestDate": "Wed, 29 Aug 2023 17:05:01 CST", "accessKey": "ae2cc5cc5e8211ea978a186590d96509", "userId":"562b89493b1a40e1b97ea05e50dd8170", "regionId":"fecnjniakfkn2314ndekqldedcsadfg"}
请求体body
{ "pageNumber":"1", "pageSize":"10"}
响应示例
{ "statusCode": "200", "message": "查询成功", "returnObj": { "aliases": { "alias": [ { "aliasName": "addqweqwsd", "cmkUuid": "00f57b81-91d5-4b65-9007-6195528f8a37" }, { "aliasName": "addqweqwsd", "cmkUuid": "00f57b81-91d5-4b65-9007-6195528f8a37" } ] }, "pageNumber": "1", "totalCount": 1, "pageSize": "10" }}
状态码
请参考 状态码
错误码
请参考 错误码
