Documentation
Table of Contents
connector.get
説明
integer/array connector.get(object parameters)
このメソッドは、与えられたパラメーターに従ってコネクタオブジェクトを取得することができます。
このメソッドは、Super adminタイプのユーザーのみ利用可能です。メソッドを呼び出す権限は、ユーザーの役割の設定で取り消すことができます。詳細はユーザーの役割を参照してください。
パラメーター
(object) 目的の出力を定義するパラメーター。
このメソッドは、次のパラメーターをサポートします。
| パラメーター | タイプ | 説明 |
|---|---|---|
| connectorids | ID/array | 指定されたIDを持つコネクタのみを返します。 |
| selectTags | query | コネクタタグフィルターを使用してtagsプロパティを返します。countをサポートします。 |
| sortfield | string/array | 指定されたプロパティによって結果を並べ替えます。 利用可能な値: connectorid、name、data_type、status。 |
| countOutput | 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パラメーターが使用されている場合、取得したオブジェクトの数
例
すべてのコネクタを取得する
すべてのコネクタとそのプロパティに関するすべてのデータを取得します。
リクエスト :
{ "jsonrpc": "2.0", "method": "connector.get", "params": { "output": "extend", "selectTags": ["tag", "operator", "value"], "preservekeys": true }, "id": 1 }レスポンス :
{ "jsonrpc": "2.0", "result": [ { "connectorid": "1", "name": "Export of item values", "protocol": "0", "data_type": "0", "url": "{$DATA_EXPORT_VALUES_URL}", "item_value_type": "31", "authtype": "4", "username": "{$DATA_EXPORT_VALUES_USERNAME}", "password": "{$DATA_EXPORT_VALUES_PASSWORD}", "token": "", "max_records": "0", "max_senders": "4", "max_attempts": "2", "attempt_interval": "10s", "timeout": "10s", "http_proxy": "{$DATA_EXPORT_VALUES_PROXY}", "verify_peer": "1", "verify_host": "1", "ssl_cert_file": "{$DATA_EXPORT_VALUES_SSL_CERT_FILE}", "ssl_key_file": "{$DATA_EXPORT_VALUES_SSL_KEY_FILE}", "ssl_key_password": "", "description": "", "status": "1", "tags_evaltype": "0", "tags": [ { "tag": "component", "operator": "0", "value": "memory" } ] }, { "connectorid": "2", "name": "Export of events", "protocol": "0", "data_type": "1", "url": "{$DATA_EXPORT_EVENTS_URL}", "item_value_type": "31", "authtype": "5", "username": "", "password": "", "token": "{$DATA_EXPORT_EVENTS_BEARER_TOKEN}", "max_records": "0", "max_senders": "2", "max_attempts": "1", "attempt_interval": "5s", "timeout": "5s", "http_proxy": "", "verify_peer": "1", "verify_host": "1", "ssl_cert_file": "", "ssl_key_file": "", "ssl_key_password": "", "description": "", "status": "1", "tags_evaltype": "0", "tags": [ { "tag": "scope", "operator": "0", "value": "performance" } ] } ], "id": 1 }ソース
CConnector:get() in ui/include/classes/api/services/CConnector.php.