proxy.update

説明

object proxy.update(object/array proxies)

このメソッドは、既存のプロキシを更新することができます。

パラメータ

(object/array) 更新するプロキシのプロパティ。

各プロキシに対して proxyid プロパティを定義する必要があり、その他のプロパティはすべて任意です。渡されたプロパティのみが更新され、その他はすべて変更されません。

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

戻り値

(object) proxyids プロパティの下に、更新されたプロキシのIDを含むオブジェクトを返します。

例

プロキシが監視するホストの変更

指定された2つのホストを監視するようにプロキシを更新します。

リクエスト :

{
    "jsonrpc": "2.0",
    "method": "proxy.update",
    "params": {
        "proxyid": "10293",
        "hosts": [
            {
                "hostid": "10294"
            },
            {
                "hostid": "10295"
            },
        ]
    },
    "id": 1
}

レスポンス :

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

プロキシステータスの変更

プロキシをアクティブプロキシに変更し、名前を"Active proxy"に変更します。

リクエスト :

{
    "jsonrpc": "2.0",
    "method": "proxy.update",
    "params": {
        "proxyid": "10293",
        "name": "Active proxy",
        "operating_mode": "0"
    },
    "id": 1
}

レスポンス :

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

プロキシをプロキシグループへ追加

ID"5"のプロキシを更新し、ID""1のプロキシ ループに追加します。

リクエスト :

{
    "jsonrpc": "2.0",
    "method": "proxy.create",
    "params": {
        "proxyid": "5",
        "proxy_groupid": "1",
        "local_address": "127.0.0.1"
    },
    "id": 1
}

レスポンス :

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

関連項目

• ホスト
• プロキシグループ

ソース

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