proxygroup.delete

説明

object proxygroup.delete(array proxyGroupIds)

このメソッドを使用すると、プロキシグループを削除できます。

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

パラメータ

(array) 消去するプロキシグループのID

戻り値

(object) proxy_groupidsプロパティの下にある、削除されたプロキシグループのIDを含むオブジェクトを返す。

例

複数のプロキシグループを削除する

2つのプロキシグループを削除します。

リクエスト :

{
    "jsonrpc": "2.0",
    "method": "proxygroup.delete",
    "params": [
        "5",
        "10"
    ],
    "id": 1
}

レスポンス :

{
    "jsonrpc": "2.0",
    "result": {
        "proxy_groupids": [
            "5",
            "10"
        ]
    },
    "id": 1
}

ソース

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