遍历分组
接口描述
按照一定条件遍历当前账号所能查看的部分或所有分组。
请求说明
接口ID | 协议 | 方法 | PATH |
---|---|---|---|
8 | HTTPS | GET | /openapi/v1/stp/user/groups |
PATH参数
无
URL参数
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
size | int | 否 | 分页大小,最大值为10000 |
page | int | 否 | 页数,最小值为1 |
wheres | string | 否 | 参见WHERES参数 |
accesskey_id | string | 是 | 参见签名认证 |
expires | int | 是 | 参见签名认证 |
signature | string | 是 | 参见签名认证 |
wheres允许填入的k:
参数 | 类型 | 说明 |
---|---|---|
id | string | 分组ID |
name | string | 分组名称 |
remark | string | 备注 |
请求示例
GET https://open.vzicloud.com/openapi/v1/stp/user/groups?page=1&size=10&accesskey_id=8d9EsDAD2115Q5PM8tuP6g1IdAglkayp&expires=1619022787&signature=G29eTBjMm0gZF7cpXNLX7Hrn0yM%3D HTTP/1.1
返回说明
返回参数
参数 | 类型 | 说明 |
---|---|---|
size | int | 当前分页大小 |
page | int | 当前分页页码 |
total | int | 符合条件的分组总数 |
items | list | 分组列表 |
+ id | string | 分组id |
+ create_time | string | 分组创建时间 |
+ company_id | string | 公司id |
+ name | string | 分组名称 |
+ update_time | string | 分组上次修改时间 |
+ remark | string | 备注 |
注:返回参数里可能还包含其他信息但未在上面的表格内列出,请勿使用!
返回示例
{
"page": 1,
"total": 2,
"items": [
{
"id": 1,
"create_time": "2021-06-18 11:44:03.575794",
"company_id": 1,
"name": "测试分组",
"update_time": "2021-06-18 11:44:03.575794",
"remark": ""
},
{
"id": 2,
"create_time": "2021-08-11 13:55:42.007764",
"company_id": 1,
"name": "test",
"update_time": "2021-08-11 13:55:42.007764",
"remark": ""
}
],
"size": 10000
}