Last updated: 2020-07-17 11:07:43

1. API Description

Domain name for API request:

This API is used to query the purchasable regions.

A maximum of 20 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example:

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: DescribeRegions.
Version Yes String Common parameter. The value used for this API: 2017-03-12.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Number of returned results.
RegionSet Array of RegionInfo Region information set.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying all regions

Input Example
&<common request parameters>

Output Example

  "Response": {
    "RequestId": "0872c9bb-0540-4ac4-80cf-ba63bd771b0a",
    "TotalCount": 7,
    "RegionSet": [
        "Region": "ap-guangzhou",
        "RegionName": "South China (Guangzhou)",
        "RegionId": 1,
        "RegionState": "AVAILABLE"
        "Region": "ap-chengdu",
        "RegionName": "Southwest China (Chengdu)",
        "RegionId": 16,
        "RegionState": "AVAILABLE"
        "Region": "ap-shanghai",
        "RegionName": "East China (Shanghai)",
        "RegionId": 4,
        "RegionState": "AVAILABLE"
        "Region": "na-toronto",
        "RegionName": "North America (Toronto)",
        "RegionId": 6,
        "RegionState": "UNAVAILABLE"
        "Region": "ap-shanghai-fsi",
        "RegionName": "East China (Shanghai Finance)",
        "RegionId": 7,
        "RegionState": "AVAILABLE"
        "Region": "ap-beijing",
        "RegionName": "North China (Beijing)",
        "RegionId": 8,
        "RegionState": "AVAILABLE"
        "Region": "na-siliconvalley",
        "RegionName": "West US (Silicon Valley)",
        "RegionId": 15,
        "RegionState": "AVAILABLE"

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.


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.UnauthorizedOperation Authentication failed.
InternalError Internal error. When this error occurs, please contact customer service for assistance.
InternalError.DBError Backend database execution error.
InvalidParameter Invalid input parameter.
InvalidParameterValue.InterfaceNameNotFound Incorrect ACTION.
InvalidParameterValue.RegionNotSupported The current region is not supported.
InvalidParameterValue.StructParseFailed An error occurred while parsing parameters.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback