批量更新

Description 说明

object template.massupdate(object **parameters**)

This method allows to simultaneously replace or remove related objects and update properties on multiple templates. 此方法允许同时替换或删除相关对象并更新多个模板上的属性。

Parameters 参数

(object) Parameters containing the IDs of the templates to update and the properties that should be updated. (object)参数包含需要更新的模板ID以及需要更新的属性。 Additionally to the standard template properties, the method accepts the following parameters. 除standard template properties之外,该方法接受以下参数。

Parameter 参数Type 类型Description 说明
templates
(required 必须)
object/array 对象/数组Templates to be updated. 需要更新的模板。

The templates must have the templateid property defined. 模板必须已定义templateid属性。
groupsobject/array 对象/数组Host groups to replace the current host groups the templates belong to. 替换所属模板的当前主机组。

The host groups must have the groupid property defined. 主机组必须已定义groupid属性。
hostsobject/array 对象/数组Hosts and templates to replace the ones the templates are currently linked to. 替换当前链接模板的主机和模板。

Both hosts and templates must use the hostid property to pass an ID. 主机和模板都必须使用hostid属性传递唯一ID。
macrosobject/array 对象/数组User macros to replace the current user macros on the given templates. 替换指定模板上的当前用户宏。
templates_clearobject/array 对象/数组Templates to unlink and clear from the given templates. 从指定模板中取消链接并清除数据。

The templates must have the templateid property defined. 模板必须已定义templateid属性。
templates_linkobject/array 对象/数组Templates to replace the currently linked templates. 替换当前链接的模板。

The templates must have the templateid property defined. 模板必须已定义templateid属性。

Return values 返回值

(object) Returns an object containing the IDs of the updated templates under the templateids property. (object)返回一个对象,此对象包含在templateids中已更新模板的ID。

Examples 范例

Replacing host groups 替换主机组

Unlink and clear template “10091” from the given templates. 从指定的模板中取消链接并清除ID为“10091”的模板。

Request 请求:

  1. {
  2. "jsonrpc": "2.0",
  3. "method": "template.massupdate",
  4. "params": {
  5. "templates": [
  6. {
  7. "templateid": "10085"
  8. },
  9. {
  10. "templateid": "10086"
  11. }
  12. ],
  13. "templates_clear": [
  14. {
  15. "templateid": "10091"
  16. }
  17. ]
  18. },
  19. "auth": "038e1d7b1735c6a5436ee9eae095879e",
  20. "id": 1
  21. }

Response 响应:

  1. {
  2. "jsonrpc": "2.0",
  3. "result": {
  4. "templateids": [
  5. "10085",
  6. "10086"
  7. ]
  8. },
  9. "id": 1
  10. }

See also 参考

Source 源码

CTemplate::massUpdate() in frontends/php/include/classes/api/services/CTemplate.php. CTemplate::massUpdate()方法可在frontends/php/include/classes/api/services/CTemplate.php中参考。