connector.get

Descripción

integer/array connector.get(object parameters)

El método permite recuperar objetos conectores según los parámetros dados.

Este método solo está disponible para el tipo de usuario Super administrador. Los permisos para llamar al método se pueden revocar en la configuración de roles de usuario. Consulte Roles de usuario para obtener más información.

Parámetros

(objeto) Parámetros que definen la salida deseada.

El método admite los siguientes parámetros.

Parámetro	Tipo	Descripción
connectorids	cadena/matriz	Devuelve solo conectores con los ID proporcionados.
selectTags	consulta	Devuelve una propiedad `tags` con conector filtro de etiquetas. Admite `count`.
sortfield	string/array	Ordena el resultado por las propiedades dadas. Valores posibles: `connectorid`, `name`, `data_type`, `status`.
countOutput	booleano	Estos parámetros, que son comunes para todos los métodos `get`, se describen en detalle en el comentario de referencia.
excludeSearch	booleano
filter	objeto
limit	entero
output	consulta
preservekeys	booleano
search	objeto
searchByAny	booleano
searchWildcardsEnabled	booleano
sortorder	cadena/matriz
startSearch	booleano

Valores de retorno

(entero/matriz) Devuelve:

una matriz de objetos;
el recuento de objetos recuperados, si se ha utilizado el parámetro countOutput.

Ejemplos

Recuperando todos los conectores

Recupere todos los datos sobre todos los conectores y sus propiedades.

Solicitud:

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

Respuesta:

{
       "jsonrpc": "2.0",
       "result": [
       {
       "connectorid": "1",
       "name": "Export of item values",
       "protocol": "0",
       "data_type": "0",
       "url": "{$DATA_EXPORT_VALUES_URL}",
       "max_records": "0",
       "max_senders": "4",
       "max_attempts": "2",
       "timeout": "10s",
       "http_proxy": "{$DATA_EXPORT_VALUES_PROXY}",
       "authtype": "4",
       "username": "{$DATA_EXPORT_VALUES_USERNAME}",
       "password": "{$DATA_EXPORT_VALUES_PASSWORD}",
       "token": "",
       "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}",
       "max_records": "0",
       "max_senders": "2",
       "max_attempts": "2",
       "timeout": "5s",
       "http_proxy": "",
       "authtype": "5",
       "username": "",
       "password": "",
       "token": "{$DATA_EXPORT_EVENTS_BEARER_TOKEN}",
       "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
       }

Fuente

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

Documentation