获取
说明
integer/array usergroup.get(object parameters)
该方法允许根据给定的参数检索用户组。
参数
(object) 定义所需输出的参数。
该方法支持以下参数。
| 属性 类 | 说明 | |
|---|---|---|
| status | integer | 只返回具有给定状态的用户组。 请参阅用户组页面以获取支持的状态列表。 |
| userids | string/array | 只返回包含给定用户的用户组。 |
| usrgrpids | string/array | 只返回具有给定ID的用户组。 |
| with_gui_access | integer | 只返回具有给定前端身份验证方法的用户组。 有关支持的方法的列表，请参阅 用户组页面。 |
| selectTagFilters | query | 在tag_filter属性中返回基于用户组标记的权限。它具有以下属性: groupid - (string) 主机组的ID;tag - (string) 标记名称;value - (string) 标记值. |
| selectUsers | query | 在“users”属性中返回用户组中的用户。 |
| selectRights | query | 在“权限”属性中返回用户组权限。 它具有以下属性： 权限 - （integer）访问级别到主机组;id - （string）主机组的ID。有关主机组的访问级别列表，请参阅用户组页面。 |
| limitSelects | integer | 限制子选择返回的记录数。 |
| sortfield | string/array | 按照给定的属性对结果进行排序。 可能的值为： usrgrpid，name。 |
| countOutput | flag | 参考说明中详细描述了所有“获得”方法的常用参数。. |
| editable | boolean | |
| excludeSearch | flag | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | flag | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | flag | |
返回值
(integer/array) 返回：
- 一组对象;
- 如果已经使用“countOutput”参数，则检索到的对象的计数。
示例
检索已启用的用户组
检索所有已启用的用户组。
Request:
{
"jsonrpc": "2.0",
"method": "usergroup.get",
"params": {
"output": "extend",
"status": 0
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Response:
{
"jsonrpc": "2.0",
"result": [
{
"usrgrpid": "7",
"name": "Zabbix administrators",
"gui_access": "0",
"users_status": "0",
"debug_mode": "1"
},
{
"usrgrpid": "8",
"name": "Guests",
"gui_access": "0",
"users_status": "0",
"debug_mode": "0"
},
{
"usrgrpid": "11",
"name": "Enabled debug mode",
"gui_access": "0",
"users_status": "0",
"debug_mode": "1"
},
{
"usrgrpid": "12",
"name": "No access to the frontend",
"gui_access": "2",
"users_status": "0",
"debug_mode": "0"
},
{
"usrgrpid": "14",
"name": "Read only",
"gui_access": "0",
"users_status": "0",
"debug_mode": "0"
},
{
"usrgrpid": "18",
"name": "Deny",
"gui_access": "0",
"users_status": "0",
"debug_mode": "0"
}
],
"id": 1
}参见
来源
CUserGroup::get() in frontends/php/include/classes/api/services/CUserGroup.php.