You are viewing documentation for the development version, it may be incomplete.
Join our translation project and help translate Zabbix documentation into your native language.

hostgroup.delete

説明

object hostgroup.delete(array hostGroupIds)

このメソッドは、ホストグループを削除することができます。

以下の場合、ホストグループを削除することはできません。

  • このグループのみに属するホストが含まれている。
  • 内部としてマークされている。
  • ホストプロトタイプで使用されている。
  • グローバルスクリプトで使用されている。
  • 相関関係で使用されている。

このメソッドは、AdminおよびSuper adminタイプのユーザーのみ利用可能です。メソッドを呼び出す権限は、ユーザーの役割の設定で取り消すことができます。詳細はユーザーの役割を参照してください。

パラメーター

(array) 削除するホストグループのID。

戻り値

(object) groupidsプロパティの下にある削除されたホストグループのIDを含むオブジェクトを返します。

複数のホストグループの削除

2つのホストグループを削除します。

リクエスト:

{
           "jsonrpc": "2.0",
           "method": "hostgroup.delete",
           "params": [
               "107824",
               "107825"
           ],
           "id": 1
       }

レスポンス:

{
           "jsonrpc": "2.0",
           "result": {
               "groupids": [
                   "107824",
                   "107825"
               ]
           },
           "id": 1
       }

ソース

CHostGroup::delete() in ui/include/classes/api/services/CHostGroup.php.