Last updated: 2020-09-25 14:26:47

1. API Description

Domain name for API request:

This API (DescribeProxyGroupList) is used to pull the list of connection groups and the basic information of each connection group.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: DescribeProxyGroupList.
Version Yes String Common parameter. The value used for this API: 2018-05-29.
Region No String Common parameter. This parameter is not required for this API.
Offset Yes Integer Offset. The default value is 0.
Limit Yes Integer Number of returned results. The default value is 20. The maximum value is 100.
ProjectId Yes Integer Project ID. Value range:
-1: all projects of this user
0: default project
Other values: specified project
TagSet.N No Array of TagPair Tag list. If this field exists, the list of the resources with the tag will be pulled.
It supports up to 5 tags. If there are two or more tags, the connection groups tagged any of them will be pulled.
Filters.N No Array of Filter Filter conditions.
The limit on Filter.Values of each request is 5.
RealServerRegion - String - Required: No - Filter by origin server region; Refer to the RegionId in the results returned by DescribeDestRegions API.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Total number of connection groups.
ProxyGroupList Array of ProxyGroupInfo List of connection groups.
Note: This field may return null, indicating that no valid values can be obtained.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying connection group list

Input Example
&<Common request parameters>

Output Example

  "Response": {
    "TotalCount": 2,
    "RequestId": "8b6bb93c-0dce-4513-a274-1410f276307c",
    "ProxyGroupList": [
        "Status": 0,
        "Domain": null,
        "ProjectId": 0,
        "GroupName": "t4",
        "TagSet": [],
        "RealServerRegionInfo": {
          "RegionId": "EastChina",
          "RegionName": "EastChina"
        "GroupId": "lg-mh4k07v5"
        "Status": 0,
        "Domain": null,
        "ProjectId": 0,
        "GroupName": "sandytest2",
        "TagSet": [],
        "RealServerRegionInfo": {
          "RegionId": "EastChina",
          "RegionName": "EastChina"
        "GroupId": "lg-d5y6ei3b"

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.


TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
AuthFailure.NotEnterpriseAuthorization Not an organizational customer.
FailedOperation Operation failed.
InternalError Internal error.
InvalidParameter Incorrect parameter.
InvalidParameterValue Incorrect parameter value.
MissingParameter Missing parameter.
ResourceNotFound The resource does not exist.
ResourceUnavailable The resource is unavailable.
UnauthorizedOperation Unauthorized operation.
UnknownParameter Unknown parameter.