Queries the regions in which Time Series Database (TSDB) instances can be deployed.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String No DescribeRegions

The operation that you want to perform. Set the value to DescribeRegions.

RegionId String No cn-hangzhou

The ID of the region.
ZoneId String No cn-hangzhou-h

The ID of the zone.
AcceptLanguage String No zh-CN

The language of the returned value. Valid values:

  • zh-CN: Chinese
  • en-US: English
  • ja: Japanese

Default value: zh-CN

Response parameters

Parameter Type Example Description
Regions Array of Region

The collection of regions.
Region
LocalName String China (Hangzhou)

The name of the region.
RegionEndpoint String hitsdb.aliyuncs.com

The endpoint of the region.
RegionId String cn-hangzhou

The ID of the region.
RequestId String BDDB1954-002B-4249-B2DF-2CDDA0259668

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeRegions
&<Common request parameters>

Sample success responses

XML format 

<DescribeRegionsResponse>
      <RequestId>DBB70386-45C6-4E92-B239-4A764E32CE4C</RequestId>
      <Regions>
            <Region>
                  <RegionId>cn-hangzhou</RegionId>
                  <RegionEndpoint>hitsdb.aliyuncs.com</RegionEndpoint>
                  <LocalName>China (Hangzhou)</LocalName>
            </Region>
            <Region>
                  <RegionId>cn-shanghai</RegionId>
                  <RegionEndpoint>hitsdb.aliyuncs.com</RegionEndpoint>
                  <LocalName>China (Shanghai)</LocalName>
            </Region>
            <Region>
                  <RegionId>cn-qingdao</RegionId>
                  <RegionEndpoint>hitsdb.aliyuncs.com</RegionEndpoint>
                  <LocalName>China (Qingdao)</LocalName>
            </Region>
            <Region>
                  <RegionId>cn-beijing</RegionId>
                  <RegionEndpoint>hitsdb.aliyuncs.com</RegionEndpoint>
                  <LocalName>China(Beijing)</LocalName>
            </Region>
            <Region>
                  <RegionId>cn-huhehaote</RegionId>
                  <RegionEndpoint>hitsdb.aliyuncs.com</RegionEndpoint>
                  <LocalName>China (Hohhot)</LocalName>
            </Region>
            <Region>
                  <RegionId>cn-shenzhen</RegionId>
                  <RegionEndpoint>hitsdb.aliyuncs.com</RegionEndpoint>
                  <LocalName>China (Shenzhen)</LocalName>
            </Region>
            <Region>
                  <RegionId>ap-southeast-1</RegionId>
                  <RegionEndpoint>hitsdb.aliyuncs.com</RegionEndpoint>
                  <LocalName>Singapore (Singapore)</LocalName>
            </Region>
      </Regions>
</DescribeRegionsResponse>

JSON format 

{
	"RequestId": "DBB70386-45C6-4E92-B239-4A764E32CE4C",
	"Regions": {
		"Region": [
			{
				"RegionId": "cn-hangzhou",
				"RegionEndpoint": "hitsdb.aliyuncs.com",
				"LocalName": "China (Hangzhou)"
			},
			{
				"RegionId": "cn-shanghai",
				"RegionEndpoint": "hitsdb.aliyuncs.com",
				"LocalName": "China (Shanghai)"
			},
			{
				"RegionId": "cn-qingdao",
				"RegionEndpoint": "hitsdb.aliyuncs.com",
				"LocalName": "China (Qingdao)"
			},
			{
				"RegionId": "cn-beijing",
				"RegionEndpoint": "hitsdb.aliyuncs.com",
				"LocalName": "China (Beijing)"
			},
			{
				"RegionId": "cn-huhehaote",
				"RegionEndpoint": "hitsdb.aliyuncs.com",
				"LocalName": "China (Hohhot)"
			},
			{
				"RegionId": "cn-shenzhen",
				"RegionEndpoint": "hitsdb.aliyuncs.com",
				"LocalName": "China (Shenzhen)"
			},
			{
				"RegionId": "ap-southeast-1",
				"RegionEndpoint": "hitsdb.aliyuncs.com",
				"LocalName": "Singapore (Singapore)"
			}
		]
	}
}

Error codes

For a list of error codes, visit the API Error Center.