接口描述
本接口(ListGroups)可用于查询用户组列表。
请求域名:
cam.api.qcloud.com
输入参数
以下请求参数列表仅列出了接口请求参数,未列出 公共请求参数。
参数名称 | 类型 | 必选 | 描述 |
---|---|---|---|
page | int | 否 | 页码,默认值是 1,从 1 开始,不能大于 200 |
rp | int | 否 | 每页数量,默认值是 20,必须大于 0 且小于或等于 200 |
keyword | string | 否 | 按用户组名称匹配 |
输出参数
参数名称 | 类型 | 描述 |
---|---|---|
totalNum | int | 用户组总数 |
groupInfo | array | 用户组数组,数组每个成员有 groupId(用户组 ID)、groupName(用户组名)、createTime(用户组创建时间)、remark(用户组描述)字段 |
示例
输入
https://cam.api.qcloud.com/v2/index.php
?rp=10
&page=1
&SignatureMethod=HmacSHA256
&Action=ListGroups
&Region=gz
&SecretId=************************************************************
&Nonce=21810
&Timestamp=1510736488
&RequestClient=SDK_PHP_1.1
&Signature=d8ZMD4byKJB0vBVqLqj0NJoyMa3c5DtFsZcbw1oLCEk%3D
输出
{
"code": 0,
"message": "",
"codeDesc": "Success",
"data": {
"groupInfo": [
{
"groupId": 26705,
"groupName": "ckwmwsllx",
"channel": 3,
"remark": "这很西游5",
"createTime": "2017-10-23 20:49:49"
},
{
"groupId": 23742,
"groupName": "gtdx",
"channel": 3,
"remark": null,
"createTime": "2017-07-24 19:42:39"
}
],
"totalNum": "2"
}
}
错误码
参见 错误码。