connector.get

Descripció

integer/array connector.get(object parameters)

El mètode permet recuperar els objectes de connectors segons els paràmetres proveïts.

Aquest mètode és disponible només per a usuaris de tipus Super admin. Els permisos per cridar al mètode es poden revocar a les configuracions de rols d'usuari. Per a més informació, veieu Rols d'usuari.

Paràmetres

(objet) Paràmetres que defineixen la sortida esperada.

El mètode admet els paràmetres següents.

Paràmetre	Tipus	Descripció
connectorids	ID/array	Retorna només connectors amb els identificadors donats.
selectTags	query	Retorna una propietat `tags` amb el filtre d'etiqueta del connector. Admet `count`.
sortfield	string/array	Ordena el resultat segons les propietats donades. Els valors possibles són: `connectorid`, `name`, `data_type`, `status`.
countOutput	boolean	Aquests paràmetres es descriuen als comentaris de referència.
excludeSearch	boolean
filter	object
limit	integer
output	query
preservekeys	boolean
search	object
searchByAny	boolean
searchWildcardsEnabled	boolean
sortorder	string/array
startSearch	boolean

Valors de retorn

(integer/array) Retorna un d'entre:

una taula d'objectes;
el recompte d'objectes recuperats, si s'empra el paràmetre countOutput.

Exemples

Recuperar tots els connectors

Recuperar tota la informació de tots els connectors i les seves propietats.

Petició:

{  "jsonrpc": "2.0",  "method": "connector.get",  "params": {  "output": "extend",  "selectTags": ["tag", "operator", "value"],  "preservekeys": true  },  "id": 1 }

Resposta:

{  "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 }

Font

CConnector::get() a ui/include/classes/api/services/CConnector.php.

Documentation