接口功能介绍
列出所有别名
接口约束
请保证账户余额大于0
URI
POST /v1/keyName/listAlias
路径参数
无
Query参数
无
请求参数
请求头header参数
请参见请求消息头
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| pageNumber | 是 | String | 页数 | 1 | |
| pageSize | 是 | String | 每页展示的别名数量 | 10 |
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| code | 是 | String | 返回码，取值范围： 200：成功 400：参数缺失或错误 401：用户验证错误 404：操作目标不可用 500：系统内部错误 |
200 | |
| errorCode | 是 | String | 错误码 | KMS.0514 | |
| msg | 是 | String | 调用结果信息 | 生成数据密钥成功 | |
| data | 是 | Object | 接口返回结果 | returnObj |
表 returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| totalCount | 是 | int | 别名总数 | 100 | |
| pageSize | 是 | String | 每页展示的别名数量 | 10 | |
| pageNumber | 是 | String | 页数 | 1 | |
| aliases | 是 | String | 别名信息 | aliases |
表 aliases
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| alias | 是 | List | 别名信息 | aliasList |
表 aliasList
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| aliasName | 是 | String | 别名 | addqweqwsd | |
| cmkUuid | 是 | String | 密钥id | 00f57b81-91d5-4b65-9007-6195528f8a37 |
请求示例
请求头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
{
"pageNumber":"1",
"pageSize":"10"
}
响应示例
{
"code": "200",
"errorCode": null,
"msg": "查询成功",
"data": {
"aliases": {
"alias": [
{
"aliasName": "addqweqwsd",
"cmkUuid": "00f57b81-91d5-4b65-9007-6195528f8a37"
},
{
"aliasName": "addqweqwsd",
"cmkUuid": "00f57b81-91d5-4b65-9007-6195528f8a37"
}
]
},
"pageNumber": "1",
"totalCount": 1,
"pageSize": "10"
}
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功。 |
| 400 | 表示参数缺失或错误。 |
| 401 | 表示用户验证错误。 |
| 404 | 表示操作目标不可用。 |
| 500 | 表示系统内部错误。 |
错误码
请参考 错误码说明。
