proxy.get
描述
integer/array proxy.get(object parameters)
该方法允许根据给定参数检索proxies.
此方法可供任何类型的用户使用. 调用该方法的权限可以在用户角色设置中撤销. 更多信息请参阅 User roles.
参数
(object) 定义所需输出的参数.
该方法支持以下参数.
| 参数 | 数据类型 | 描述 |
|---|---|---|
| proxyids | ID/array | 仅返回具有给定ID的proxies. |
| proxy_groupids | ID/array | 仅返回属于给定proxy 组的proxies. |
| selectAssignedHosts | query | 返回一个assignedHosts属性，包含分配给proxy的主机.支持 count. |
| selectHosts | query | 返回一个hosts属性，包含由proxy监控的主机.支持 count. |
| selectProxyGroup | query | 返回一个proxyGroup属性，包含proxy 组的object. |
| sortfield | string/array | 按给定属性排序结果. 可能值: proxyid, name, operating_mode. |
| countOutput | boolean | 这些参数在通用get方法参数中有描述. |
| editable | boolean | |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
返回值
(integer/array) 返回以下两种结果之一:
- 一个包含array的objects数组
- 若使用了
countOutput参数，则返回检索到的objects数量
示例
检索所有 proxies
获取所有已配置的proxies及其接口
执行请求:
响应:
{
"jsonrpc": "2.0",
"result": [
{
"proxyid": "11",
"name": "Active proxy",
"proxy_groupid": "0",
"local_address": "",
"local_port": "10051",
"operating_mode": "0",
"description": "",
"allowed_addresses": "",
"address": "127.0.0.1",
"port": "10051",
"tls_connect": "1",
"tls_accept": "1",
"tls_issuer": "",
"tls_subject": "",
"custom_timeouts": "0",
"timeout_zabbix_agent": "",
"timeout_simple_check": "",
"timeout_snmp_agent": "",
"timeout_external_check": "",
"timeout_db_monitor": "",
"timeout_http_agent": "",
"timeout_ssh_agent": "",
"timeout_telnet_agent": "",
"timeout_script": "",
"last_access": "1693391880",
"version": "70000",
"compatibility": "1",
"state": "1"
},
{
"proxyid": "12",
"name": "Passive proxy",
"proxy_groupid": "1",
"local_address": "127.0.0.1",
"local_port": "10051",
"operating_mode": "1",
"description": "",
"allowed_addresses": "",
"address": "127.0.0.1",
"port": "10051",
"tls_connect": "1",
"tls_accept": "1",
"tls_issuer": "",
"tls_subject": "",
"custom_timeouts": "1",
"timeout_zabbix_agent": "5s",
"timeout_simple_check": "5s",
"timeout_snmp_agent": "5s",
"timeout_external_check": "5s",
"timeout_db_monitor": "5s",
"timeout_http_agent": "5s",
"timeout_ssh_agent": "5s",
"timeout_telnet_agent": "5s",
"timeout_script": "5s",
"lastaccess": "1693391875",
"version": "60400",
"compatibility": "2",
"state": "2"
}
],
"id": 1
}另请参阅
来源
CProxy::get() 位于 ui/include/classes/api/services/CProxy.php 文件中。