列出用户组 - ListGroups
简介
列出用户组
定义
公共参数
| 参数名 | 类型 | 描述信息 | 必填 |
|---|---|---|---|
| Action | string | 对应的 API 指令名称，当前 API 为 ListGroups | Yes |
| PublicKey | string | 用户公钥，可从 控制台 获取 | Yes |
| Signature | string | 根据公钥及 API 指令生成的用户签名，参见 签名算法 | Yes |
请求参数
| 参数名 | 类型 | 描述信息 | 必填 |
|---|
响应字段
| 字段名 | 类型 | 描述信息 | 必填 |
|---|---|---|---|
| RetCode | int | 返回状态码，为 0 则为成功返回，非 0 为失败 | Yes |
| Action | string | 操作指令名称 | Yes |
| Message | string | 返回错误消息，当 RetCode 非 0 时提供详细的描述信息 | No |
| Groups | array[Group] | 用户组数组 | Yes |
| TotalCount | int | 总数 | Yes |
数据模型
Group
| 字段名 | 类型 | 描述信息 | 必填 |
|---|---|---|---|
| GroupName | string | 用户组名称 | Yes |
| Description | string | 用户组描述信息 | Yes |
| CreatedAt | int | 用户组创建时间戳 | No |
示例
请求示例
https://api.an-link.com/?Action=ListGroups响应示例
{
"Action": "ListGroupsResponse",
"Groups": [
{
"CreateAt": 7,
"Description": "ftZJOUpz",
"GroupName": "Zgriftqa",
"JoinedAt": "OsVugnMn"
}
],
"Message": "hwocmdDy",
"RetCode": 0,
"TotalCount": 8
}