Tencent Cloud

search by keyword

Recent Pages

Documentation

DescribeRegions

Last updated: 2020-03-06 18:52:27

1. API Description

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

This API is used to query regions.

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

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	No	String	Common parameter. This parameter is not required for this API.

3. Output Parameters

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

4. Example

Example1 Example

Input Example

GET https://cvm.tencentcloudapi.com/?Action=DescribeRegions
&<Common request parameters>

Output Example

{
  "Response": {
    "TotalCount": 9,
    "RegionSet": [
      {
        "Region": "ap-beijing",
        "RegionName": "North China (Beijing)",
        "RegionState": "AVAILABLE"
      },
      {
        "Region": "ap-guangzhou",
        "RegionName": "South China (Guangzhou)",
        "RegionState": "AVAILABLE"
      },
      {
        "Region": "ap-hongkong",
        "RegionName": "Hong Kong/Macao/Taiwan (Hong Kong, China)",
        "RegionState": "AVAILABLE"
      },
      {
        "Region": "ap-shanghai",
        "RegionName": "East China (Shanghai)",
        "RegionState": "AVAILABLE"
      },
      {
        "Region": "ap-shanghai-fsi",
        "RegionName": "East China (Shanghai Finance)",
        "RegionState": "AVAILABLE"
      },
      {
        "Region": "ap-shenzhen-fsi",
        "RegionName": "South China (Shenzhen Finance)",
        "RegionState": "AVAILABLE"
      },
      {
        "Region": "ap-singapore",
        "RegionName": "Southeast Asia (Singapore)",
        "RegionState": "AVAILABLE"
      },
      {
        "Region": "na-siliconvalley",
        "RegionName": "Western U.S. (Silicon Valley)",
        "RegionState": "AVAILABLE"
      },
      {
        "Region": "na-toronto",
        "RegionName": "North America (Toronto)",
        "RegionState": "AVAILABLE"
      }
    ],
    "RequestId": "C563943B-3BEA-FE92-29FE-591EAEB7871F"
  }
}

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.