proxygroup.create

説明

object proxygroup.create(object/array proxyGroups)

このメソッドを使用すると、新しいプロキシグループを作成できます。

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

パラメータ

(object/array) 作成するプロキシグループ。

このメソッドは、標準のプロキシグループプロパティを持つプロキシグループを受け付けます。

戻り値

(object) は、proxy_groupids プロパティに作成されたプロキシグループの ID を含むオブジェクトを返します。 返される ID の順序は、渡されたプロキシグループの順序と一致します。

例

プロキシグループを作成する

カスタム設定でプロキシグループを作成します。

リクエスト :

{
    "jsonrpc": "2.0",
    "method": "proxygroup.create",
    "params": {
        "name": "Proxy group",
        "failover_delay": "5m",
        "min_online": "10"
    },
    "id": 1
}

レスポンス :

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

ソース

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