Documentation|Tencent Cloud

Recent Pages

Documentation

DescribeRegions

Last updated: 2020-07-17 11:19:42

1. API Description

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

This API is used to obtain all regions supported by TKE.

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: DescribeRegions.
Version	Yes	String	Common parameter. The value used for this API: 2018-05-25.
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 Note: this field may return null, indicating that no valid values can be obtained.
RegionInstanceSet	Array of RegionInstance	## Region List Note: this field may return null, indicating that no valid values can be obtained.
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 This example shows you how to get the region list.

This example shows you how to get the region list.

Input Example

https://tke.tencentcloudapi.com/?Action=DescribeRegions
&<Common request parameter>

Output Example

{
  "Response": {
    "RequestId": "eac6b301-a322-493a-8e36-83b295459398"
  }
}

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.

API 3.0 Explorer

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

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
FailedOperation	Operation failed
InternalError	Internal error
InternalError.AccountUserNotAuthenticated	Account not verified.
InternalError.CamNoAuth	You do not have permissions.
InternalError.Db	DB error.
InternalError.DbAffectivedRows	DB error
InternalError.DbRecordNotFound	Record not found.
LimitExceeded	Quota limit exceeded
MissingParameter	Parameter is missing
ResourceInUse	Resource is in use
ResourceNotFound	Resource does not exist
ResourceUnavailable	Resource is unavailable
UnauthorizedOperation	Unauthorized operation
UnknownParameter	Unknown parameter error
UnsupportedOperation	Operation is not supported