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.
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: CheckProxyCreate. |
Version | Yes | String | Common Params. The value used for this API: 2018-05-29. |
Region | No | String | Common Params. This parameter is not required. |
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 . |
NetworkType | No | String | Network type. Valid values: normal (default), cn2 |
PackageType | No | String | Package type of connection groups. Valid values: Thunder (general connection group), Accelerator (game accelerator connection group), and CrossBorder (cross-border connection group). |
Http3Supported | No | Integer | (Disused) HTTP3.0 is supported by default when IPAddressVersion is IPv4 . |
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. |
POST / HTTP/1.1
Host: gaap.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CheckProxyCreate
<Common request parameters>
{
"Concurrent": "2",
"Bandwidth": "10",
"RealServerRegion": "SouthChina",
"AccessRegion": "EastChina"
}
{
"Response": {
"CheckFlag": 1,
"RequestId": "5c680029-66b2-4be8-9630-7bd316ce70dd"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
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. |
ResourceUnavailable.AccountViolation | Restricted resources found in your account. Check your inbox and email for details. |
Was this page helpful?