Table of Contents
获取
描述
integer/array usermacro.get(object parameters)
此方法用于根据给定参数查询主机宏和全局宏。
此方法适用于任何类型的用户。可在用户角色设置中撤销调用该方法的权限，参阅用户角色获取详情。
参数
(object) 定义所需输出的参数。
该方法支持以下参数。
| 参数 | 类型 | 描述 |
|---|---|---|
| globalmacro | flag | 返回全局宏而不是主机宏。 |
| globalmacroids | ID/array | 仅返回具有给定ID的全局宏。 |
| groupids | ID/array | 根据给定主机群组仅返回属于主机或模板的主机宏。 |
| hostids | ID/array | 仅返回属于给定主机或模板的宏。 |
| hostmacroids | ID/array | 仅返回给定主机宏ID的主机宏。 |
| inherited | boolean | 如果设置为 true 仅返回从模板继承过来的主机原型的宏。 |
| selectHostGroups | query | 在 hostgroups属性中返回拥有这个主机宏的主机组。仅在查询主机宏时有效。 |
| selectHosts | query | 在 hosts 属性中返回拥有这个主机宏的主机。仅在查询主机宏时有效。 |
| selectTemplateGroups | query | 在 templategroups 属性中返回拥有这个模板宏的模板组。仅在查询模板宏时有效。 |
| selectTemplates | query | 在 templates 属性中返回拥有这个主机宏的模板。仅在查询主机宏时有效。 |
| sortfield | string/array | 按给定参数排序返回结果。 可能的值: macro。 |
| countOutput | boolean | 参考说明中详细描述了所有 get方法的通用参数。 |
| editable | boolean | |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean | |
| selectGroups (deprecated) |
query | 此参数已弃用，请使用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
}Retrieving host macros for a template
Retrieve host macros defined for template "10265" that contain "STATUS" in the macro name.
{
"jsonrpc": "2.0",
"method": "usermacro.get",
"params": {
"output": "extend",
"hostids": "10265",
"search": {
"macro": "STATUS"
}
},
"id": 1
}Response:
{
"jsonrpc": "2.0",
"result": [
{
"hostmacroid": "6709",
"hostid": "10265",
"macro": "{$APACHE.STATUS.HOST}",
"value": "",
"description": "The hostname or IP address of the Apache status page host.",
"type": "0",
"automatic": "0",
"config": {
"type": "1",
"priority": "1",
"section_name": "",
"label": "Apache status host",
"description": "Hostname or IP address of the Apache status page host.",
"required": "1",
"regex": "",
"options": []
}
},
{
"hostmacroid": "814",
"hostid": "10265",
"macro": "{$APACHE.STATUS.PATH}",
"value": "server-status?auto",
"description": "The URL path of the Apache status page.",
"type": "0",
"automatic": "0",
"config": {
"type": "1",
"priority": "3",
"section_name": "",
"label": "Apache status page path",
"description": "URL path of the Apache status page.",
"required": "1",
"regex": "",
"options": []
}
},
{
"hostmacroid": "815",
"hostid": "10265",
"macro": "{$APACHE.STATUS.PORT}",
"value": "80",
"description": "The port of the Apache status page.",
"type": "0",
"automatic": "0",
"config": {
"type": "1",
"priority": "2",
"section_name": "",
"label": "Apache status page port",
"description": "In the range from 1 to 65535 inclusive.",
"required": "1",
"regex": "^-?([0-9]+|(([0-9]+)\\.([0-9]+)))$",
"options": []
}
},
{
"hostmacroid": "816",
"hostid": "10265",
"macro": "{$APACHE.STATUS.SCHEME}",
"value": "http",
"description": "The request scheme, which may be either HTTP or HTTPS.",
"type": "0",
"automatic": "0",
"config": {
"type": "2",
"priority": "4",
"section_name": "",
"label": "Request scheme",
"description": "Request scheme, which may be either HTTP or HTTPS.",
"required": "0",
"regex": "",
"options": [
{
"value": "http",
"text": "HTTP"
},
{
"value": "https",
"text": "HTTPS"
}
]
}
}
],
"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.