connector.get

Description

integer/array connector.get(object parameters)

La méthode permet de récupérer des objets connecteurs en fonction des paramètres donnés.

Cette méthode n'est disponible que pour le type d'utilisateur Super admin. Les autorisations d'appeler la méthode peuvent être révoquées dans les paramètres du rôle utilisateur. Voir Rôles utilisateur pour plus d'informations.

Parameters

(object) Paramètres définissant la sortie souhaitée.

La méthode prend en charge les paramètres suivants.

Paramètre	Type	Description
connectorids	string/array	Renvoyer uniquement les connecteurs avec les ID donnés.
selectTags	query	Renvoie une propriété `tags` avec le connecteur tag filter. Prend en charge `count`.
sortfield	string/array	Trier le résultat selon les propriétés données. Valeurs possibles : `connectorid`, `name`, `data_type`, `status`.
countOutput	boolean	Ces paramètres étant communs à toutes les méthodes `get` sont décrits en détail dans commentaire de référence.
excludeSearch	boolean
filter	object
limit	integer
output	query
preservekeys	boolean
search	object
searchByAny	boolean
searchWildcardsEnabled	boolean
sortorder	string/array
startSearch	boolean

Valeurs de retour

((integer/array) Renvoie soit :

un tableau d'objets ;
le nombre d'objets récupérés, si le paramètre countOutput a été utilisé.

Exemples

Récupération de tous les connecteurs

Récupère toutes les données sur tous les connecteurs et leurs propriétés.

Requête:

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

Réponse:

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

Source

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

Documentation