International
中国站
Console
PrevNext
search by keyword

Recent Pages

Documentation
Global Application Acceleration Platform
    Documentation
    Download PDF

    CheckProxyCreate

    Last updated: 2021-07-09 19:08:23
    Download PDF

    1. API Description

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

    This API (CheckProxyCreate) is used to query whether an acceleration connection with the specified configuration can be created.

    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: CheckProxyCreate.
    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.
    AccessRegion Yes String Access (acceleration) region of the connection. The value can be obtained via the DescribeAccessRegionsByDestRegion API.
    RealServerRegion Yes String Origin server region of the connection. The value can be obtained via the DescribeDestRegions API.
    Bandwidth Yes Integer Connection bandwidth cap. Unit: Mbps.
    Concurrent Yes Integer Connection concurrence cap, which indicates the maximum number of simultaneous online connections. Unit: 10,000 connections.
    GroupId No String Connection group ID that needs to be entered when a connection is created in a connection group
    IPAddressVersion No String IP version. Valid values: IPv4 (default), IPv6.

    3. Output Parameters

    Parameter Name Type Description
    CheckFlag Integer Queries whether a connection with the specified configuration can be created. 1: yes; 0: no.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying whether connection can be created

    Input Example

    https://gaap.tencentcloudapi.com/?Action=CheckProxyCreate
&AccessRegion=EastChina
&RealServerRegion=SouthChina
&Bandwidth=10
&Concurrent=2
&<Common request parameters>

    Output Example

    {
  "Response": {
    "CheckFlag": 1,
    "RequestId": "5c680029-66b2-4be8-9630-7bd316ce70dd"
  }
}

    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
    FailedOperation Operation failed.
    InternalError Internal error.
    InvalidParameter Incorrect parameter.
    InvalidParameterValue Incorrect parameter value.
    InvalidParameterValue.InvalidBandwidth The bandwidth value is not in the range.
    InvalidParameterValue.InvalidConcurrency The number of concurrences is not in the range.
    InvalidParameterValue.UnknownAccessRegion The acceleration region is not found or you have no access permission to it.
    InvalidParameterValue.UnknownDestRegion The origin server region is not found or you have no access permission to it.
    MissingParameter Missing parameter.
    tencent
    Copyright © 2013-2021 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy