DescribeRegionAndPrice

Last updated: 2021-09-15 17:10:47

1. API Description

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

This API (DescribeRegionAndPrice) is used to obtain the origin server regions and the bandwidth price gradient.

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: DescribeRegionAndPrice.
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.
IPAddressVersion No String IP version. Valid values: IPv4 (default), IPv6.
PackageType No String Package type of connection groups. Valid values: Thunder (general connection group) and Accelerator (game accelerator connection group).

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Total number of origin server regions
DestRegionSet Array of RegionDetail List of origin server region details
BandwidthUnitPrice Array of BandwidthPriceGradient Connection bandwidth price gradient
Currency String Currency type of bandwidth price:
CNY (Chinese Yuan)
USD (United States Dollar)
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Obtaining the origin server region and the bandwidth tiered pricing

This example shows you how to obtain the origin server region and the bandwidth tiered pricing.

Input Example

https://gaap.tencentcloudapi.com/?Action=DescribeRegionAndPrice
&<Common request parameters>

Output Example

{
  "Response": {
    "TotalCount": 26,
    "Currency": "USD",
    "RequestId": "61b759bb-3d4c-4d7d-a8dc-a7bf2be63328",
    "BandwidthUnitPrice": [
      {
        "BandwidthRange": [
          0,
          20
        ],
        "BandwidthUnitPrice": 130,
        "DiscountBandwidthUnitPrice": 130
      },
      {
        "BandwidthRange": [
          20,
          100
        ],
        "BandwidthUnitPrice": 90,
        "DiscountBandwidthUnitPrice": 90
      },
      {
        "BandwidthRange": [
          100,
          500
        ],
        "BandwidthUnitPrice": 70,
        "DiscountBandwidthUnitPrice": 70
      },
      {
        "BandwidthRange": [
          500,
          2000
        ],
        "BandwidthUnitPrice": 60,
        "DiscountBandwidthUnitPrice": 60
      },
      {
        "BandwidthRange": [
          2000,
          -1
        ],
        "BandwidthUnitPrice": 50,
        "DiscountBandwidthUnitPrice": 50
      }
    ],
    "DestRegionSet": [
      {
        "RegionId": "NorthChina",
        "RegionName": "Chinese mainland - North China"
      },
      {
        "RegionId": "EastChina",
        "RegionName": "Chinese mainland - East China"
      },
      {
        "RegionId": "SouthChina",
        "RegionName": "Chinese mainland - South China"
      },
      {
        "RegionId": "SouthwestChina",
        "RegionName": "Chinese mainland - Southwest China"
      },
      {
        "RegionId": "Hongkong",
        "RegionName": "Hong Kong (China)"
      },
      {
        "RegionId": "SoutheastAsia",
        "RegionName": "Singapore"
      },
      {
        "RegionId": "Korea",
        "RegionName": "South Korea - Seoul"
      },
      {
        "RegionId": "Europe",
        "RegionName": "Germany - Frankfurt"
      },
      {
        "RegionId": "NorthAmerica",
        "RegionName": "Western US - Silicon Valley"
      },
      {
        "RegionId": "Canada",
        "RegionName": "Canada"
      },
      {
        "RegionId": "WestIndia",
        "RegionName": "Western India - Mumbai"
      },
      {
        "RegionId": "Thailand",
        "RegionName": "Thailand - Bangkok"
      },
      {
        "RegionId": "Virginia",
        "RegionName": "Eastern US - Virginia"
      },
      {
        "RegionId": "Russia",
        "RegionName": "Russia"
      },
      {
        "RegionId": "Japan",
        "RegionName": "Japan - Tokyo"
      },
      {
        "RegionId": "Taipei",
        "RegionName": "Taipei (China)"
      },
      {
        "RegionId": "SL_AZURE_NorthUAE",
        "RegionName": "United Arab Emirates - Dubai (Partner IDC)"
      },
      {
        "RegionId": "SL_AZURE_EastAUS",
        "RegionName": "Eastern Australia - Sydney (Partner IDC)"
      },
      {
        "RegionId": "SL_AZURE_NorthCentralUSA",
        "RegionName": "US - Illinois (Partner IDC)"
      },
      {
        "RegionId": "SL_AZURE_SouthIndia",
        "RegionName": "Southern India - Chennai (Partner IDC)"
      },
      {
        "RegionId": "SL_AZURE_SouthBrazil",
        "RegionName": "Southern Brazil - Sao Paulo (Partner IDC)"
      },
      {
        "RegionId": "SL_AZURE_SoutheastAsia",
        "RegionName": "Singapore (Partner IDC)"
      },
      {
        "RegionId": "SL_AZURE_CentralFrance",
        "RegionName": "Central France - Paris (Partner IDC)"
      },
      {
        "RegionId": "SL_AZURE_SouthEngland",
        "RegionName": "Southern UK - London (Partner IDC)"
      },
      {
        "RegionId": "SL_AZURE_EastUS",
        "RegionName": "Eastern US - Virginia (Partner IDC)"
      },
      {
        "RegionId": "SL_AZURE_WestUS",
        "RegionName": "Western US - California (Partner IDC)"
      }
    ]
  }
}

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.NotEnterpriseAuthorization Not an organizational customer.
FailedOperation Operation failed.
InternalError Internal error.
InvalidParameter Incorrect parameter.
InvalidParameterValue Incorrect parameter value.
MissingParameter Missing parameter.
ResourceNotFound The resource does not exist.
UnauthorizedOperation Unauthorized operation.