tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeProxyGroupList

Last updated: 2023-07-13 15:25:35

1. API Description

Domain name for API request: gaap.tencentcloudapi.com.

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 Params. The value used for this API: DescribeProxyGroupList.
Version Yes String Common Params. The value used for this API: 2018-05-29.
Region No String Common Params. This parameter is not required.
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
Filters.N No Array of Filter Filter condition
Each request can have a maximum of 5 filter conditions for Filter.Values.
RealServerRegion - String - Required: No - Filter by origin server region. You can also check the value of RegionId returned by the DescribeDestRegions API.
PackageType - String - Required: No - Filter by type of connection groups, which can be Thunder (general connection group) or Accelerator (silver connection group).
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.

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 the list of connection groups

Input Example

https://gaap.tencentcloudapi.com/?Action=DescribeProxyGroupList
&ProjectId=0
&Offset=0
&Limit=20
&<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",
                    "RegionArea": "EastChina",
                    "RegionAreaName": "EastChina",
                    "IDCType": "ec"
                },
                "GroupId": "lg-mh4k07v5"
            },
            {
                "Status": 0,
                "Domain": null,
                "ProjectId": 0,
                "GroupName": "sandytest2",
                "TagSet": [],
                "RealServerRegionInfo": {
                    "RegionId": "EastChina",
                    "RegionName": "EastChina",
                    "RegionArea": "EastChina",
                    "RegionAreaName": "EastChina",
                    "IDCType": "ec"
                },
                "GroupId": "lg-d5y6ei3b"
            }
        ]
    }
}

5. Developer Resources

SDK

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 CAM signature/authentication error.
AuthFailure.NotEnterpriseAuthorization Not an organizational customer.
AuthFailure.UnauthorizedOperation The sub-account is not authorized for this operation.
FailedOperation Operation failed.
FailedOperation.UserNotConfirmProtocol Protocol not activated.
InternalError Internal error.
InvalidParameter Incorrect parameter.
InvalidParameterValue Incorrect parameter value.
MissingParameter Missing parameter.
ResourceNotFound The resource does not exist.
ResourceUnavailable The resource is unavailable.
ResourceUnavailable.AccountViolation Restricted resources found in your account. Check your inbox and email for details.
UnauthorizedOperation Unauthorized operation.
UnknownParameter Unknown parameter.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy