Documentation
Table of Contents
proxy.create
説明
object proxy.create(object/array proxies)
このメソッドは、新しいプロキシを作成することができます。
このメソッドは、Super adminタイプのユーザーのみ利用可能です。メソッドを呼び出す権限は、ユーザーの役割の設定で取り消すことができます。詳細はユーザーの役割を参照してください。
パラメーター
(object/array) 作成するプロキシ。
proxyの標準プロパティに加えて、このメソッドは以下のパラメーターを受け付けます。
| パラメーター | タイプ | 説明 |
|---|---|---|
| hosts | array | プロキシによって監視されるホスト。 ホストがすでに別のプロキシによって監視されている場合は、現在のプロキシに再割り当てされます。 ホストには hostidプロパティのみが定義されている必要があります。 |
戻り値
(object) proxyidsプロパティの下に作成されたプロキシのIDを含むオブジェクトを返します。返されるIDの順序は、渡されたプロキシの順序と一致します。
例
アクティブプロキシの作成
アクションプロキシ"Active proxy"を作成し、それによって監視されるホストを割り当てます。
リクエスト :
{ "jsonrpc": "2.0", "method": "proxy.create", "params": { "name": "Active proxy", "operating_mode": "0", "hosts": [ { "hostid": "10279" } ] }, "id": 1 }レスポンス :
パッシブプロキシの作成
パッシブプロキシ"Passive proxy"を作成し、それによって監視される2つのホストを割り当てます。
リクエスト :
{ "jsonrpc": "2.0", "method": "proxy.create", "params": { "name": "Passive proxy", "operating_mode": "1", "address": "127.0.0.1", "port": "10051", "hosts": [ { "hostid": "10192" }, { "hostid": "10139" } ] }, "id": 1 }レスポンス :
プロキシを作成して、プロキシグループへ追加
アクティブプロキシ"Active proxy"を作成し、ID"1"のプロキシグループに追加します。
リクエスト :
{ "jsonrpc": "2.0", "method": "proxy.create", "params": { "name": "Active proxy", "proxy_groupid": "1", "operating_mode": "0" }, "id": 1 }レスポンス :
参照
ソース
CProxy::create() in ui/include/classes/api/services/CProxy.php.