[comment]: # ({9936c391-51323acb})
# 获取

[comment]: # ({/9936c391-51323acb})

[comment]: # ({05aa6b77-0b47b101})
### 描述

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

该方法允许根据给定的参数检索Proxy组。

::: noteclassic
此方法适用于任何类型的用户。调用该方法的权限可以在用户角色设置中撤销。有关更多信息，请参阅
[用户角色](/manual/web_interface/frontend_sections/users/user_roles)。
:::

[comment]: # ({/05aa6b77-0b47b101})

[comment]: # ({4298141a-e8ed9d1c})
### 参数

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

该方法支持以下参数。

|参数|[类型](/manual/api/reference_commentary#data-types)|描述|
|--|--|------|
|proxy_groupids|ID/array|仅返回具有给定 ID 的 proxy 组。|
|proxyids|ID/array|仅返回包含给定 proxy 的 proxy 组。|
|selectProxies|query|返回 [`proxies`](/manual/api/reference/proxy/object) 属性，其中包含属于该 proxy 组的 proxy。<br><br>支持 `count`。|
|sortfield|string/array|按给定属性对结果进行排序。<br><br>可选值：`proxy_groupid`、`name`。|
|countOutput|boolean|这些参数在[参考说明](/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]: # ({/4298141a-e8ed9d1c})

[comment]: # ({07ca11ca-5d7f971e})
### 返回值

`(integer/array)` 返回以下任一值：

- 包含对象的数组；
- 如果已使用 `countOutput` 参数，则返回检索到的对象的数量。

[comment]: # ({/07ca11ca-5d7f971e})

[comment]: # ({b41637d2-c32e5272})
### 示例

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

[comment]: # ({8e2ed653-78dbbfff})
#### 检索所有Proxy组

检索所有已配置的Proxy组（含Proxy）。

[请求](/manual/api#执行请求):

```json
{
	"jsonrpc": "2.0",
	"method": "proxygroup.get",
	"params": {
		"output": "extend",
		"selectProxies": ["proxyid", "name"]
	},
	"id": 1
}
```

响应:

```json
{
	"jsonrpc": "2.0",
	"result": [{
			"proxy_groupid": "1",
			"name": "Proxy Group 1",
			"failover_delay": "1m",
			"min_online": "3",
			"description": "",
			"state": "1",
			"proxies": [{
					"proxyid": "1",
					"name": "Proxy 1"
				},
				{
					"proxyid": "2",
					"name": "Proxy 2"
				}
			]
		},
		{“
			proxy_groupid”：“ 2”，“ name”：“ Proxy Group 2”，“ failover_delay”：“ 10 m”，“ min_online”：“ 3”，“ description”：“”，“ state”：“ 3”，“ proxies”：[{“
				proxyid”：“ 3”，“ name”：“ Proxy 3”
			}, {“
				proxyid”：“ 4”，“ name”：“ Proxy 4”
			}, {“
				proxyid”：“ 5”，“ name”：“ Proxy 5”
			}]
		}
	],
	“id”： 1
}
```

[comment]: # ({/8e2ed653-78dbbfff})

[comment]: # ({606fe203-df1d5f90})
### 另请参阅

- [Proxy](/manual/api/reference/proxy/object#proxy)

[comment]: # ({/606fe203-df1d5f90})

[comment]: # ({e04ef422-01660b7a})
### 来源

*ui/include/classes/api/services/CProxyGroup.php* 中的 CProxyGroup::get()。

[comment]: # ({/e04ef422-01660b7a})