proxy.update

説明

object proxy.update(object/array proxies)

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

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

パラメーター

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

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

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

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

戻り値

(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.

Documentation

proxy.update

説明

パラメーター

戻り値

例

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

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

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

参照

ソース