[comment]: # ({82eb5968-70dbc2c9})
# 获取

[comment]: # ({/82eb5968-70dbc2c9})

[comment]: # ({9c87db90-09597ae3})
### Description 描述

`integer/array proxy.get(object parameters)`

The method allows to retrieve proxies according to the given parameters.
该方法允许根据给定的参数查询代理。

[comment]: # ({/9c87db90-09597ae3})

[comment]: # ({efc56137-2367307b})
### Parameters 参数

`(object)` Parameters defining the desired output.
`(object)`定义所需输出的参数。

The method supports the following parameters. 此方法支持一下参数

|Parameter|Type|Description|
|---------|----|-----------|
|proxyids|string/array|Return only proxies with the given IDs. 仅返回所给IDs的代理|
|selectHosts|query|Return hosts monitored by the proxy in the `hosts` property. 返回在`hosts`属性中代理监控的主机|
|selectInterface|query|Return the proxy interface used by a passive proxy in the `interface` property.返回在`interface`属性中被动代理使用代理接口|
|sortfield|string/array|Sort the result by the given properties.<br><br>Possible values are: `hostid`, `host` and `status`. 根据所给的属性进行排序<br>\\\\可能的值：`hostid`, `host` 和 `status`.|
|countOutput|boolean|These parameters being common for all `get` methods are described in detail in the [reference commentary](/manual/api/reference_commentary#common_get_method_parameters). 改参数适用于所有的`get`方法，详细描述是在[reference commentary](/manual/api/reference_commentary#common_get_method_parameters)|
|editable|boolean|^|
|excludeSearch|boolean|^|
|filter|object|^|
|limit|integer|^|
|output|query|^|
|preservekeys|boolean|^|
|search|object|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|sortorder|string/array|^|
|startSearch|boolean|^|

[comment]: # ({/efc56137-2367307b})

[comment]: # ({856f45d3-7223bab1})
### Return values 返回值

`(integer/array)` Returns either:

-   an array of objects;
-   the count of retrieved objects, if the `countOutput` parameter has
    been used.
-   一个对象数组
-   搜索到对象的数量，如果`countOutput`对象被使用

[comment]: # ({/856f45d3-7223bab1})

[comment]: # ({7b785443-b41637d2})
### Examples 示例如下

[comment]: # ({/7b785443-b41637d2})

[comment]: # ({3ddcc7ec-26e8a895})
#### Retrieve all proxies 检索所有的代理

Retrieve all configured proxies and their interfaces.
检索所有配置的代理和他们的接口

Request:

``` {.java}
{
    "jsonrpc": "2.0",
    "method": "proxy.get",
    "params": {
        "output": "extend",
        "selectInterface": "extend"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}
```

Response:

``` {.java}
{
    "jsonrpc": "2.0",
    "result": [
        {
            "interface": [],
            "host": "Active proxy",
            "status": "5",
            "lastaccess": "0",
            "proxyid": "30091",
            "description": "",
            "tls_connect": "1",
            "tls_accept": "1",
            "tls_issuer": "",
            "tls_subject": "",
            "tls_psk_identity": "",
            "tls_psk": ""
        },
        {
            "interface": {
                "interfaceid": "30109",
                "hostid": "30092",
                "useip": "1",
                "ip": "127.0.0.1",
                "dns": "",
                "port": "10051"
            ],
            "host": "Passive proxy",
            "status": "6",
            "lastaccess": "0",
            "proxyid": "30092",
            "description": ""
        }
    ],
    "id": 1
}
```

[comment]: # ({/3ddcc7ec-26e8a895})

[comment]: # ({273e0fd8-273e0fd8})
### See also

-   [Host](/manual/api/reference/host/object#host)
-   [Proxy interface](object#proxy_interface)

[comment]: # ({/273e0fd8-273e0fd8})

[comment]: # ({20bd554e-20bd554e})
### Source

CProxy::get() in
*frontends/php/include/classes/api/services/CProxy.php*.

[comment]: # ({/20bd554e-20bd554e})