Global Application Acceleration Platform
- Product Introduction
- Purchase Guide
- Operation Guide
- Access Management
- Obtaining Real Client IP
- Obtaining Real Client IP Through TOA (TCP Only)
- Invoking Linux Backend Version
- Invoking Windows Backend Version
- Obtaining Real Client IP Through Proxy Protocol (TCP Only)
- Obtaining Real Client IP Through HTTP Header (HTTP/HTTPS)
- API Documentation
- Making API Requests
- Origin Server APIs
- Listener APIs
- Rule APIs
- Connection Group APIs
- Connection APIs
- Certificate APIs
- Other APIs
- Service Agreement
- Product Policy
DocumentationGlobal Application Acceleration PlatformAPI DocumentationConnection APIsDescribeAccessRegionsByDestRegion
DescribeAccessRegionsByDestRegion
Last updated: 2024-12-03 10:30:13
1. API Description
Domain name for API request: gaap.intl.tencentcloudapi.com.
This API is used to query the available accelerator region based on the origin server region.
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: DescribeAccessRegionsByDestRegion. |
| Version | Yes | String | Common Params. The value used for this API: 2018-05-29. |
| Region | No | String | Common Params. This parameter is not required. |
| DestRegion | Yes | String | Origin server region: the DescribeDestRegions API returns the value of RegionId field of DestRegionSet. |
| IPAddressVersion | No | String | IP version. Valid values: IPv4 (default), IPv6. |
| PackageType | No | String | Package type of connection groups. Valid values: Thunder (general), Accelerator (specific for games), and CrossBorder (cross-MLC-border connection). |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | The number of available acceleration regions |
| AccessRegionSet | Array of AccessRegionDetial | List of available acceleration region information |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
4. Example
Example1 Querying the available accelerator region based on the origin server region
Input Example
POST / HTTP/1.1
Host: gaap.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAccessRegionsByDestRegion
<Common request parameters>
{
"DestRegion": "SouthChina"
}
Output Example
{
"Response": {
"AccessRegionSet": [
{
"RegionId": "ap-singapore",
"RegionName": "Singapore",
"ConcurrentList": [
2,
5,
10,
20,
30
],
"BandwidthList": [
10,
20,
50,
100,
200,
500,
1000
],
"RegionArea": "Asia",
"RegionAreaName": "Asia",
"IDCType": "dc",
"FeatureBitmap": 71
}
],
"RequestId": "5c680029-66b2-4be8-9630-7bd316ce70dd",
"TotalCount": 1
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
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. |
| InvalidParameterValue.UnknownDestRegion | The origin server region is not found or you have no access permission to it. |
| MissingParameter | Missing parameter. |
| ResourceNotFound | The resource does not exist. |
| ResourceUnavailable.AccountViolation | Restricted resources found in your account. Check your inbox and email for details. |
| UnknownParameter | Unknown parameter. |
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No