Sidebar
Table of Contents
查询用户宏
描述
integer/array usermacro.get(object parameters)
此方法用于根据给定参数查询主机宏和全局宏.
此方法适用于所有用户类型. 可以在用户角色设置中撤销调用该方法的权限. 更多信息请查看 User roles.
Parameters
(object) 定义所需输出的参数.
该方法支持以下参数.
| 参数 | 类型 | 描述 |
|---|---|---|
| globalmacro | flag | 返回全局宏而不是主机宏. |
| globalmacroids | string/array | 仅返回具有给定ID的全局宏. |
| groupids | string/array | 根据给定主机群组仅返回属于主机或模板的主机宏. |
| hostids | string/array | 仅返回属于给定主机或模板的宏. |
| hostmacroids | string/array | 仅返回给定主机宏ID的主机宏. |
| inherited | boolean | 如果设置为 true 仅返回从模板继承过来的主机原型的宏. |
| selectGroups | query | 在 groups 属性中返回拥有这个主机宏的主机组. 仅在查询主机宏时有效. |
| selectHosts | query | 在 hosts 属性中返回拥有这个主机宏的主机. 仅在查询主机宏时有效. |
| selectTemplates | query | 在 templates 属性中返回拥有这个主机宏的模板. 仅在查询主机宏时有效. |
| sortfield | string/array | 按给定参数排序返回结果. 可用值: macro. |
| countOutput | boolean | 这些参数对所有 get 方法是通用的，在 reference commentary 页面有详细描述. |
| editable | boolean | |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
返回值
(integer/array) 返回二者之一:
- 一个对象列表;
- 查询结果数量, 如果使用了
countOutput参数.
示例
查询一个主机的主机宏
查询主机"10198"所有的主机宏.
请求:
{
"jsonrpc": "2.0",
"method": "usermacro.get",
"params": {
"output": "extend",
"hostids": "10198"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}返回:
{
"jsonrpc": "2.0",
"result": [
{
"hostmacroid": "9",
"hostid": "10198",
"macro": "{$INTERFACE}",
"value": "eth0",
"description": "",
"type": "0"
},
{
"hostmacroid": "11",
"hostid": "10198",
"macro": "{$SNMP_COMMUNITY}",
"value": "public",
"description": "",
"type": "0"
}
],
"id": 1
}查询全局宏
查询所有的全局宏.
请求:
{
"jsonrpc": "2.0",
"method": "usermacro.get",
"params": {
"output": "extend",
"globalmacro": true
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"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.