configuration.export

configuration.export

描述

string configuration.export(object parameters)

此方法允许将配置数据导出并序列化为字符串。

该方法适用于任何类型的用户。可以在用户角色设置中撤销调用该方法的权限。更多信息请查看用户角色

参数

(object) 参数定义了导出的对象以及使用的格式。

参数	类型	说明
format (required)	string	导出数据的格式。可用值为: `yaml` - YAML; `xml` - XML; `json` - JSON; `raw` - 未处理的PHP数组.
prettyprint	boolean	通过添加缩进，使输出更具可读性。可用值为: `true` - 添加缩进; `false` - (default) 不添加缩进.
options (required)	object	要导出的对象要导出的`options`对象有以下参数： `groups` - `(array)` 要导出的主机组ID; `hosts` - `(array)` 要导出的主机ID; `images` - `(array)` 要导出的图表ID; `maps` - `(array)` 要导出的拓扑图ID; `mediaTypes` - `(array)` 要导出的媒介类型ID; `templates` - `(array)` 要导出的模板ID。

返回值

(string) 返回一个包含请求配置数据的序列化字符串

示例

导出一台主机

以XML形式导出一个主机的配置。

请求：

{
           "jsonrpc": "2.0",
           "method": "configuration.export",
           "params": {
               "options": {
                   "hosts": [
                       "10161"
                   ]
               },
               "format": "xml"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

响应：

{
           "jsonrpc": "2.0",
           "result": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<zabbix_export><version>5.4</version><date>2020-03-13T15:31:45Z</date><groups><group><uuid>6f6799aa69e844b4b3918f779f2abf08</uuid><name>Zabbix servers</name></group></groups><hosts><host><host>Export host</host><name>Export host</name><groups><group><name>Zabbix servers</name></group></groups><interfaces><interface><interface_ref>if1</interface_ref></interface></interfaces><items><item><name>Item</name><key>item.key</key><delay>30s</delay><tags><tag><tag>Application</tag><value>CPU</value></tag></tags><valuemap><name>Host status</name></valuemap><interface_ref>if1</interface_ref><request_method>POST</request_method></item></items><valuemaps><valuemap><name>Host status</name><mappings><mapping><value>0</value><newvalue>Up</newvalue></mapping><mapping><value>2</value><newvalue>Unreachable</newvalue></mapping></mappings></valuemap></valuemaps></host></hosts></zabbix_export>\n",
           "id": 1
       }

来源

CConfiguration::export() in ui/include/classes/api/services/CConfiguration.php.