获取

说明

integer/array connector.get(object parameters)

该方法允许根据给定的参数检索连接器对象。

此方法仅对“超级管理员”用户类型可用。可以在用户角色设置中撤销调用此方法的权限。 有关更多信息，请参阅用户角色。

参数

(object) 定义所需输出的参数。

该方法支持以下参数。

参数类型描述
connectoridsID/array仅返回具有给定ID的连接器。
selectTagsquery使用连接器标签过滤返回tags属性。

支持count。
sortfieldstring/array按给定的属性对结果进行排序。

可能的值：connectorid，name，data_type，status。
countOutputboolean这些参数是所有get方法的通用参数，在参考说明中有详细描述。
excludeSearchboolean
filterobject
limitinteger
outputquery
preservekeysboolean
searchobject
searchByAnyboolean
searchWildcardsEnabledboolean
sortorderstring/array
startSearchboolean

返回值

(integer/array) 返回以下之一：

  • 对象数组；
  • 如果使用了countOutput参数，则返回检索到的对象数量。

示例

获取所有连接器

检索有关所有连接器及其属性的所有数据。

请求：

  1. {
  2.            "jsonrpc": "2.0",
  3.            "method": "connector.get",
  4.            "params": {
  5.                "output": "extend",
  6.                "selectTags": ["tag", "operator", "value"],
  7.                "preservekeys": true
  8.            },
  9.            "id": 1
  10.        }

Response:

  1. {
  2.            "jsonrpc": "2.0",
  3.            "result": [
  4.                {
  5.                    "connectorid": "1",
  6.                    "name": "Export of item values",
  7.                    "protocol": "0",
  8.                    "data_type": "0",
  9.                    "url": "{$DATA_EXPORT_VALUES_URL}",
  10.                    "item_value_type": "31",
  11.                    "authtype": "4",
  12.                    "username": "{$DATA_EXPORT_VALUES_USERNAME}",
  13.                    "password": "{$DATA_EXPORT_VALUES_PASSWORD}",
  14.                    "token": "",
  15.                    "max_records": "0",
  16.                    "max_senders": "4",
  17.                    "max_attempts": "2",
  18.                    "attempt_interval": "10s",
  19.                    "timeout": "10s",
  20.                    "http_proxy": "{$DATA_EXPORT_VALUES_PROXY}",
  21.                    "verify_peer": "1",
  22.                    "verify_host": "1",
  23.                    "ssl_cert_file": "{$DATA_EXPORT_VALUES_SSL_CERT_FILE}",
  24.                    "ssl_key_file": "{$DATA_EXPORT_VALUES_SSL_KEY_FILE}",
  25.                    "ssl_key_password": "",
  26.                    "description": "",
  27.                    "status": "1",
  28.                    "tags_evaltype": "0",
  29.                    "tags": [
  30.                        {
  31.                            "tag": "component",
  32.                            "operator": "0",
  33.                            "value": "memory"
  34.                        }
  35.                    ]
  36.                },
  37.                {
  38.                    "connectorid": "2",
  39.                    "name": "Export of events",
  40.                    "protocol": "0",
  41.                    "data_type": "1",
  42.                    "url": "{$DATA_EXPORT_EVENTS_URL}",
  43.                    "item_value_type": "31",
  44.                    "authtype": "5",
  45.                    "username": "",
  46.                    "password": "",
  47.                    "token": "{$DATA_EXPORT_EVENTS_BEARER_TOKEN}",
  48.                    "max_records": "0",
  49.                    "max_senders": "2",
  50.                    "max_attempts": "1",
  51.                    "attempt_interval": "5s",
  52.                    "timeout": "5s",
  53.                    "http_proxy": "",
  54.                    "verify_peer": "1",
  55.                    "verify_host": "1",
  56.                    "ssl_cert_file": "",
  57.                    "ssl_key_file": "",
  58.                    "ssl_key_password": "",
  59.                    "description": "",
  60.                    "status": "1",
  61.                    "tags_evaltype": "0",
  62.                    "tags": [
  63.                        {
  64.                            "tag": "scope",
  65.                            "operator": "0",
  66.                            "value": "performance"
  67.                        }
  68.                    ]
  69.                }
  70.            ],
  71.            "id": 1
  72.        }

源码位置

CConnector:get() 在 *ui/include/classes/api/services/CConnector.php文件中。