tencent cloud



Last updated: 2022-08-10 16:13:20

1. API Description

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

This API (CreateProxyGroup) is used to create a 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: CreateProxyGroup.
Version Yes String Common Params. The value used for this API: 2018-05-29.
Region No String Common Params. This parameter is not required for this API.
ProjectId Yes Integer Project ID of connection group
GroupName Yes String Alias of connection group
RealServerRegion Yes String Origin server region; Reference API: DescribeDestRegions; It returnes the RegionId of the parameter RegionDetail.
TagSet.N No Array of TagPair Tag list
AccessRegionSet.N No Array of AccessConfiguration List of acceleration regions, including their names, bandwidth, and concurrence configuration.
IPAddressVersion No String IP version. Valid values: IPv4 (default), IPv6.
PackageType No String Package type of connection group. Valid values: Thunder (default) and Accelerator.
Http3Supported No Integer Specifies whether to enable HTTP3. Valid values:
0: disable HTTP3;
1: enable HTTP3.
Note that if HTTP3 is enabled for a connection, TCP/UDP access will not be allowed.
After the connection is created, you cannot change your HTTP3 setting.

3. Output Parameters

Parameter Name Type Description
GroupId String Connection Group ID
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating a connection group

Input Example

&<Common request parameters>

Output Example

  "Response": {
    "RequestId": "19a021f8-dff3-4890-8e7a-ed5054e22e49",
    "GroupId": "lg-negxun2x"

Example2 CreateProxyGroup

Input Example

Host: gaap.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateProxyGroup
<common request parameters>

    "Http3Supported": "0",
    "ProjectId": "0",
    "RealServerRegion": "Shanghai",
    "GroupName": "benny-test",
    "PackageType": "Thunder",
    "IPAddressVersion": "IPv4",
    "AccessRegionSet": [
            "NetworkType": "normal",
            "Bandwidth": "10",
            "AccessRegion": "Guangzho",
            "Concurrent": "2"

Output Example

  "Response": {
    "RequestId": "1858c87c-2110-430d-bd09-f86091127fe0",
    "GroupId": "lg-cj8rn2up"

5. Developer Resources


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.LimitNumofProxiesInGroup The number of connections in the connection group exceeded the limit.
InternalError Internal error.
InvalidParameter Incorrect parameter.
InvalidParameterValue Incorrect parameter value.
InvalidParameterValue.FeatureConflict The features to be enabled conflict with each other.
InvalidParameterValue.InvalidTags The tag is not found or you have no access permission to it.
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.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support