接口功能介绍
查询租户ak列表信息
接口约束
无
URI
POST /v1/userAkControl/listUserAk
路径参数
无
Query参数
无
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionId | 是 | String | 资源池id | fecnjniakfkn2314ndekqldedcsadfg |
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
applicationId | 是 | String | 接入点id | b2160c2c-9c70-4ca9-b808-0d186c97280d | |
pageNumber | 否 | Integer | 当前页码,不传默认为1 | 1 | |
pageSize | 否 | Integer | 页码大小,不传默认为10 | 10 |
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | 是 | String | 状态码 取值范围:200 成功 | 200 | |
message | 是 | String | 提示信息 | Success | |
returnObj | 是 | Object | 返回数据结构体 | {} | result |
error | 否 | String | 错误码 仅错误时返回 格式为{服务编码}.{错误编号} | KMS.0269 |
表 result
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
list | 是 | Array of Objects | 租户ak列表 | userAkList | |
totalCount | 是 | Integer | 总数量 | 5 | |
pageNum | 是 | Integer | 当前页码 | 1 | |
pageSize | 是 | Integer | 页码大小 | 10 |
表 userAkList
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
userAk | 是 | String | 租户ak | 09bc65a7aeea902c67dfa006c797795f | |
policy | 是 | String | ak权限 | full | |
status | 是 | String | ak状态 | 1 | |
createTime | 是 | String | 创建时间 | 2024-12-05 16:40:00 |
枚举参数
参数名 policy
枚举值 | 类型 | 说明 |
---|---|---|
full | String | 全部 |
key | String | 密钥 |
cert | String | 证书 |
参数名 status
枚举值 | 类型 | 说明 |
---|---|---|
0 | String | 禁用 |
1 | String | 启用 |
请求示例
请求url
https://{host}/v1/userAkControl/listUserAk
请求头header
{
"regionid": "fecnjniakfkn2314ndekqldedcsadfg"
}
请求体body
{
"applicationId": "b2160c2c-9c70-4ca9-b808-0d186c97280d",
"pageNumber": 1,
"pageSize": 10
}
响应示例
{
"statusCode": 200,
"message": "查询租户ak列表成功",
"returnObj": {
"list": [
{
"userAk":"09bc65a7aeea902c67dfa006c797795f",
"policy":"full",
"status":"1",
"createTime":"2024-12-05 16:40:00"
}
],
"totalCount": 1,
"pageNum": 1,
"pageSize": 10
}
}
状态码
请参考状态码章节
错误码
请参考错误码章节