Documentation
proxy.get
説明
integer/array proxy.get(object parameters)
このメソッドで、指定されたパラメーターに従ってプロキシを取得できます。
このメソッドはどのタイプのユーザーでも利用可能です。このメソッドを呼び出す権限は、ユーザーロール設定で取り消すことができます。詳しくはユーザーの役割を参照してください。
パラメータ
(object) 目的の出力を定義するパラメーター。
このメソッドは、次のパラメーターをサポートします。
| パラメータ | タイプ | 説明 |
|---|---|---|
| proxyids | string/array | 指定されたIDを持つプロキシのみを返します |
| selectHosts | query | プロキシによって監視されているホストでhostsプロパティを返します。 |
| selectInterface | query | パッシブプロキシが使用するプロキシインターフェイスでinterfaceプロパティを返します。 |
| sortfield | string/array | 指定されたプロパティで結果を並べ替えます。 利用可能な値は hostid,host,statusです。 |
| countOutput | boolean | すべてのgetメソッドに共通するこれらのパラメーターについてはリファレンス解説ページで詳しく説明されています。 |
| editable | boolean | |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
戻り値
(integer/array) 次のいずれかを返します:
- オブジェクトの配列
countOutputパラメータが使用されている場合、取得されたオブジェクトの数
例
すべてのプロキシを取得する
構成済みのすべてのプロキシとそのインターフェースを取得します。
Request:
{ "jsonrpc": "2.0", "method": "proxy.get", "params": { "output": "extend", "selectInterface": "extend" }, "auth": "038e1d7b1735c6a5436ee9eae095879e", "id": 1 }Response:
{ "jsonrpc": "2.0", "result": [ { "host": "Active proxy", "status": "5", "lastaccess": "0", "description": "", "tls_connect": "1", "tls_accept": "1", "tls_issuer": "", "tls_subject": "", "proxy_address": "", "auto_compress": "0", "proxyid": "30091", "interface": [] }, { "host": "Passive proxy", "status": "6", "lastaccess": "0", "description": "", "tls_connect": "1", "tls_accept": "1", "tls_issuer": "", "tls_subject": "", "proxy_address": "", "auto_compress": "0", "proxyid": "30092", "interface": { "interfaceid": "30109", "hostid": "30092", "useip": "1", "ip": "127.0.0.1", "dns": "", "port": "10051" ] } ], "id": 1 }参照
ソース
CProxy::get() in ui/include/classes/api/services/CProxy.php.