获取
描述
integer/array usermacro.get(object parameters)
此方法用于根据给定参数查询主机宏和全局宏。
此方法适用于任何类型的用户。可在用户角色设置中撤销调用该方法的权限，参阅用户角色获取详情。
参数
(object) 定义所需输出的参数。
该方法支持以下参数。
| 参数 | 类型 | 描述 |
|---|---|---|
| globalmacro | 标记 | 返回全局宏而非主机宏。 |
| globalmacroids | ID/数组 | 仅返回具有指定ID的全局宏。 |
| groupids | ID/数组 | 仅返回属于来自指定主机组或模板组的主机或模板的主机宏。 |
| hostids | ID/数组 | 仅返回属于指定主机或模板的宏。 |
| hostmacroids | ID/数组 | 仅返回具有指定ID的主机宏。 |
| inherited | 布尔值 | 如果设置为true，仅返回从模板继承的主机原型用户宏。 |
| selectHostGroups | 查询 | 在[hostgroups]属性中返回主机宏所属的主机组。仅在检索主机宏时使用。 |
| selectHosts | 查询 | 在[hosts]属性中返回主机宏所属的主机。仅在检索主机宏时使用。 |
| selectTemplateGroups | 查询 | 在[templategroups]属性中返回模板宏所属的模板组。仅在检索模板宏时使用。 |
| selectTemplates | 查询 | 在[templates]属性中返回主机宏所属的模板。仅在检索主机宏时使用。 |
| sortfield | 字符串/数组 | 根据给定属性对结果进行排序。 可能的值： macro。 |
| countOutput | 布尔值 | 这些参数在参考说明中描述。 |
| editable | 布尔值 | |
| excludeSearch | 布尔值 | |
| filter | 对象 | |
| limit | 整数 | |
| output | 查询 | |
| preservekeys | 布尔值 | |
| search | 对象 | |
| searchByAny | 布尔值 | |
| searchWildcardsEnabled | 布尔值 | |
| sortorder | 字符串/数组 | |
| startSearch | 布尔值 | |
| selectGroups (已废弃) |
查询 | 此参数已废弃，请改用selectHostGroups或selectTemplateGroups。在 groups属性中返回主机宏所属的主机组和模板组。仅在检索主机宏时使用。 |
返回值
(integer/array) 返回二者之一:
- 一个对象列表;
- 检索对象的计数（使用
countOutput参数时）。
示例
查询一个主机的主机宏
查询主机"10198"所有的主机宏。
请求:
{
"jsonrpc": "2.0",
"method": "usermacro.get",
"params": {
"output": "extend",
"hostids": "10198"
},
"id": 1
}响应:
{
"jsonrpc": "2.0",
"result": [
{
"hostmacroid": "9",
"hostid": "10198",
"macro": "{$INTERFACE}",
"value": "eth0",
"description": "",
"type": "0",
"automatic": "0"
},
{
"hostmacroid": "11",
"hostid": "10198",
"macro": "{$SNMP_COMMUNITY}",
"value": "public",
"description": "",
"type": "0",
"automatic": "0"
}
],
"id": 1
}查询全局宏
查询所有的全局宏。
请求:
{
"jsonrpc": "2.0",
"method": "usermacro.get",
"params": {
"output": "extend",
"globalmacro": true
},
"id": 1
}响应:
{
"jsonrpc": "2.0",
"result": [
{
"globalmacroid": "6",
"macro": "{$SNMP_COMMUNITY}",
"value": "public",
"description": "",
"type": "0"
}
],
"id": 1
}来源
CUserMacro::get() in ui/include/classes/api/services/CUserMacro.php.