说明:该功能目前处于灰度测试阶段,如需要在控制台试用,请通过 提交内测申请 的方式开通白名单。
1. 接口描述
接口请求域名:ckafka.api.qcloud.com
本接口(ListUser)用于枚举出所有的用户信息。
2. 输入参数
以下请求参数列表仅列出了接口请求参数,其它参数见 公共请求参数 页面。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
instanceId | 是 | String | 实例 ID |
searchWord | 否 | String | (过滤条件)按照用户名称过滤,支持模糊查询 |
offset | 否 | String | 偏移量,不填默认为0 |
limit | 否 | String | 返回数量,不填则默认10,最大值20 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
users | Array | 用户的列表 |
userId | Int | 用户 ID |
name | String | 用户名称 |
adminFlag | Int | 用户是否为 admin 的标识 |
ctime | String | 创建时间 |
mtime | String | 最后一次更新时间 |
4. 示例
输入:
https://domain/v2/index.php?Action=ListUser
&instanceId=ckafka-tadfqa0
&<公共请求参数>
输出:
{
"code": 0,
"message": "",
"codeDesc": "Success",
"data": {
"users": [
{
"userId": 14,
"name": "tesst2342",
"ctime": "2018-04-12 20:08:33",
"mtime": "2018-04-12 20:41:34"
},
{
"userId": 15,
"name": "tesst2f342",
"ctime": "2018-04-12 20:08:36",
"mtime": "2018-04-12 20:08:36"
},
{
"userId": 16,
"name": "tesst2fsd342",
"ctime": "2018-04-12 20:08:39",
"mtime": "2018-04-12 20:08:39"
}
],
"totalCount": 3
}
}