proxy.update

説明

object proxy.update(object/array proxies)

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

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

パラメーター

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

proxyidプロパティはプロキシごとに定義する必要があり、その他のプロパティはオプションです。渡されたプロパティのみが更新され、他は一切変更されません。

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

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

ホストにはhostidプロパティが定義されている必要があります。
interface object パッシブプロキシの既存インターフェースを置き換えるホストインターフェース。

戻り値

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

例

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

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

リクエスト :

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

レスポンス :

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

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

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

リクエスト :

{
    "jsonrpc": "2.0",
    "method": "proxy.update",
    "params": {
        "proxyid": "10293",
        "host": "Active proxy",
        "status": "5"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

レスポンス :

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

参照

ソース

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