configuration.export

描述

string configuration.export(object parameters)

此方法允许将export配置数据序列化为string格式.

该方法对所有类型用户开放. 可通过用户角色设置撤销调用权限. 更多信息请参阅User roles.

参数

(object) 定义要导出的objects及所用格式的参数

参数	数据类型	描述
format (required)	string	数据必须导出的格式。可选值： `yaml` - YAML； `xml` - XML； `json` - JSON； `raw` - 未处理的PHP array。
prettyprint	boolean	通过添加缩进使输出更易读。可选值: `true` - 添加缩进; `false` - (默认) 不添加缩进。
options (required)	object	待导出的objects. `options` object包含以下参数: `groups` - `(array)` ID的主机组用于export; `hosts` - `(array)` ID的主机用于export; `images` - `(array)` ID的图片用于export; `maps` - `(array)` ID的地图用于export; `mediaTypes` - `(array)` ID的媒体类型用于export; `templates` - `(array)` ID的模板用于export. 管理员和用户类型用户仅可export那些具有只读或读写权限permission的objects及图片,但不可操作媒体类型.

返回值

(string) 返回一个包含所请求配置数据的序列化string。

示例

导出模板

将模板"10571"的配置导出为XML string.

请求:

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

响应:

{
           "jsonrpc": "2.0",
           "result": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<zabbix_export><version>6.0</version><date>2023-01-01T12:00:00Z</date><groups><group><uuid>7df96b18c230490a9a0a9e2307226338</uuid><name>Templates</name></group></groups><templates><template><uuid>5aef0444a82a4d8cb7a95dc4c0c85330</uuid><template>New template</template><name>New template</name><groups><group><name>Templates</name></group></groups><items><item><uuid>7f1e6f1e48aa4a128e5b6a958a5d11c3</uuid><name>Zabbix agent ping</name><key>agent.ping</key></item><item><uuid>77ba228662be4570830aa3c503fcdc03</uuid><name>Apache server uptime</name><type>DEPENDENT</type><key>apache.server.uptime</key><delay>0</delay><trends>0</trends><value_type>TEXT</value_type><preprocessing><step><type>REGEX</type><parameters><parameter>&lt;dt&gt;Server uptime: (.*)&lt;/dt&gt;</parameter><parameter>\\1</parameter></parameters></step></preprocessing><master_item><key>web.page.get[127.0.0.1/server-status]</key></master_item></item><item><uuid>6805d4c39a624a8bab2cc8ab63df1ab3</uuid><name>CPU load</name><key>system.cpu.load</key><value_type>FLOAT</value_type><triggers><trigger><uuid>ab4c2526c2bc42e48a633082255ebcb3</uuid><expression>avg(/New template/system.cpu.load,3m)&gt;2</expression><name>CPU load too high on 'New host' for 3 minutes</name><priority>WARNING</priority></trigger></triggers></item><item><uuid>590efe5731254f089265c76ff9320726</uuid><name>Apache server status</name><key>web.page.get[127.0.0.1/server-status]</key><trends>0</trends><value_type>TEXT</value_type></item></items><valuemaps><valuemap><uuid>8fd5814c45d44a00a15ac6eaae1f3946</uuid><name>Zabbix agent ping</name><mappings><mapping><value>1</value><newvalue>Available</newvalue></mapping><mapping><value>0</value><newvalue>Not available</newvalue></mapping></mappings></valuemap></valuemaps></template></templates></zabbix_export>\n",
           "id": 1
       }

来源

CConfiguration::export() 位于 ui/include/classes/api/services/CConfiguration.php 文件中。

Documentation

configuration.export

描述

参数

返回值

示例

导出模板

来源