Áú»¢¶Ä²©

§¿§ä§à §á§Ö§â§Ö§Ó§à§Õ §ã§ä§â§Ñ§ß§Ú§è§í §Õ§à§Ü§å§Þ§Ö§ß§ä§Ñ§è§Ú§Ú §ã §Ñ§ß§Ô§Ý§Ú§Û§ã§Ü§à§Ô§à §ñ§Ù§í§Ü§Ñ. §±§à§Þ§à§Ô§Ú§ä§Ö §ß§Ñ§Þ §ã§Õ§Ö§Ý§Ñ§ä§î §Ö§Ô§à §Ý§å§é§ê§Ö.

connector.get

§°§á§Ú§ã§Ñ§ß§Ú§Ö

integer/array connector.get(§á§Ñ§â§Ñ§Þ§Ö§ä§â§í §à§Ò§ì§Ö§Ü§ä§Ñ)

§®§Ö§ä§à§Õ §á§à§Ù§Ó§à§Ý§ñ§Ö§ä §á§à§Ý§å§é§Ñ§ä§î §à§Ò§ì§Ö§Ü§ä§í §Ü§à§ß§ß§Ö§Ü§ä§à§â§Ñ §á§à §Ù§Ñ§Õ§Ñ§ß§ß§í§Þ §á§Ñ§â§Ñ§Þ§Ö§ä§â§Ñ§Þ.

§¿§ä§à§ä §Þ§Ö§ä§à§Õ §Õ§à§ã§ä§å§á§Ö§ß §ä§à§Ý§î§Ü§à §á§à§Ý§î§Ù§à§Ó§Ñ§ä§Ö§Ý§ð §ã §ä§Ú§á§à§Þ §Õ§à§ã§ä§å§á§Ñ §³§å§á§Ö§â-§Ñ§Õ§Þ§Ú§ß§Ú§ã§ä§â§Ñ§ä§à§â. §²§Ñ§Ù§â§Ö§ê§Ö§ß§Ú§ñ §ß§Ñ §Ó§í§Ù§à§Ó §Þ§Ö§ä§à§Õ§Ñ §Þ§à§Ø§ß§à §à§ä§à§Ù§Ó§Ñ§ä§î §Ó §ß§Ñ§ã§ä§â§à§Û§Ü§Ñ§ç §â§à§Ý§Ö§Û §á§à§Ý§î§Ù§à§Ó§Ñ§ä§Ö§Ý§ñ. §¥§à§á§à§Ý§ß§Ú§ä§Ö§Ý§î§ß§å§ð §Ú§ß§æ§à§â§Þ§Ñ§è§Ú§ð §ã§Þ. §Ó §â§Ñ§Ù§Õ§Ö§Ý§Ö §²§à§Ý§Ú §á§à§Ý§î§Ù§à§Ó§Ñ§ä§Ö§Ý§Ö§Û.

Parameters

(object) Parameters defining the desired output.

The method supports the following parameters.

Parameter Type Description
connectorids string/array Return only connectors with the given IDs.
selectTags query Return a tags property with connector tag filter.

Supports count.
sortfield string/array Sort the result by the given properties.

Possible values are: connectorid, name, data_type and status.
countOutput boolean These parameters being common for all get methods are described in detail in the reference commentary.
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Return values

(integer/array) Returns either:

  • an array of objects;
  • the count of retrieved objects, if the countOutput parameter has been used.

§±§â§Ú§Þ§Ö§â§í

Retrieving all connectors

Retrieve all data about all connectors and their properties.

Request:

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

Response:

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

§ª§ã§ä§à§é§ß§Ú§Ü

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