proxy.get
描述
integer/array proxy.get(object parameters)
该方法允许根据给定参数检索proxies。
此方法可供任何类型的用户使用。调用该方法的权限可以在用户角色设置中撤销。更多信息请参阅User roles。
参数
(object) 定义输出结果的参数
该方法支持以下参数
| 参数 | 数据类型 | 描述 |
|---|---|---|
| proxyids | string/array | 仅返回指定ID的proxies |
| selectHosts | query | 返回包含proxy监控的主机的hosts属性 |
| selectInterface | query | 返回包含被动proxy使用的proxy接口的proxy-接口属性 |
| sortfield | string/array | 按指定属性排序结果 可选值： hostid、host和status |
| 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) 返回以下两种结果之一：
- 一个包含objects的array；
- 若使用了
countOutput参数，则返回检索到的objects数量。
示例
检索所有 proxies
获取所有已配置的proxies及其接口。
请求：
{
"jsonrpc": "2.0",
"method": "proxy.get",
"params": {
"output": "extend",
"selectInterface": "extend"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}响应：
{
"jsonrpc": "2.0",
"result": [
{
"host": "Active proxy",
"status": "5",
"lastaccess": "0",
"description": "",
"tls_connect": "1",
"tls_accept": "1",
"tls_issuer": "",
"tls_subject": "",
"proxy_address": "",
"auto_compress": "0",
"proxyid": "30091",
"interface": []
},
{
"host": "Passive proxy",
"status": "6",
"lastaccess": "0",
"description": "",
"tls_connect": "1",
"tls_accept": "1",
"tls_issuer": "",
"tls_subject": "",
"proxy_address": "",
"auto_compress": "0",
"proxyid": "30092",
"interface": {
"interfaceid": "30109",
"hostid": "30092",
"useip": "1",
"ip": "127.0.0.1",
"dns": "",
"port": "10051"
]
}
],
"id": 1
}另请参阅
来源
CProxy::get() 位于 ui/include/classes/api/services/CProxy.php 文件中。