proxy.create

説明

object proxy.create(object/array proxies)

このメソッドは、新しいプロキシを作成することができます。

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

パラメーター

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

proxyの標準プロパティに加えて、このメソッドは以下のパラメーターを受け付けます。

パラメーター タイプ 説明
hosts array プロキシによって監視されるホスト。ホストがすでに別のプロキシによって監視されている場合は、現在のプロキシに再割り当てされます。

ホストにはhostidプロパティが定義されている必要があります。
interface object パッシブプロキシ用に作成されるホストインターフェース

パッシブプロキシに必要です。

戻り値

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

例

アクティブプロキシの作成

アクションプロキシ"Active proxy"を作成し、それによって監視されるホストを割り当てます。

リクエスト :

{
    "jsonrpc": "2.0",
    "method": "proxy.create",
    "params": {
        "host": "Active proxy",
        "status": "5",
        "hosts": [
            {
                "hostid": "10279"
            }
        ]
    },
    "auth": "ab9638041ec6922cb14b07982b268f47",
    "id": 1
}

レスポンス :

{
    "jsonrpc": "2.0",
    "result": {
        "proxyids": [
            "10280"
        ]
    },
    "id": 1
}

パッシブプロキシの作成

パッシブプロキシ"Passive proxy"を作成し、それによって監視される2つのホストを割り当てます。

リクエスト :

{
    "jsonrpc": "2.0",
    "method": "proxy.create",
    "params": {
        "host": "Passive proxy",
        "status": "6",
        "interface": {
            "ip": "127.0.0.1",
            "dns": "",
            "useip": "1",
            "port": "10051"
        },
        "hosts": [
            {
                "hostid": "10192"
            },
            {
                "hostid": "10139"
            }
        ]
    },
    "auth": "ab9638041ec6922cb14b07982b268f47",
    "id": 1
}

レスポンス :

{
    "jsonrpc": "2.0",
    "result": {
        "proxyids": [
            "10284"
        ]
    },
    "id": 1
}

参照

ソース

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