DescribeRegions - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

pvtz:DescribeRegions

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the response. Valid values: zh: Chinese. en: English. Default value: en. Note This parameter has a lower priority than AcceptLanguage.	zh
UserClientIp	string	No	The IP address of the user.	192.0.XX.XX
AcceptLanguage	string	No	The supported language. Valid values: zh-CN: Chinese en-US: English Default value: en-US. Note This parameter has a higher priority than Lang.	zh-CN
AuthorizedUserId	integer	No	The ID of the Alibaba Cloud account to which the authorized resources belong.	141339776561****
VpcType	string	No	The type of the VPC. Valid values: STANDARD: standard VPC. EDS: Elastic Desktop Service (EDS) VPC.	STANDARD
Scene	string	No	The scenario. Valid values: AUTH: built-in authoritative server FWD: forwarding management RA: traffic analysis	AUTH

Response elements

Element	Type	Description	Example
	object
RequestId	string	The unique ID of the request.	1E0F6898-F854-5133-A4CB-9C094152D05A
Regions	object
Region	array<object>	A list of regions.
	object	The details of a region.
LocalName	string	The display name of the region. The name is displayed in the language that you specified for the request.	华东2（上海）
RegionName	string	The name of the region.	华东2（上海）
RegionEndpoint	string	The endpoint of the service in the region.	pvtz.aliyuncs.com
RegionId	string	The ID of the region.	cn-beijing

Examples

Success response

JSON format

{
  "RequestId": "1E0F6898-F854-5133-A4CB-9C094152D05A",
  "Regions": {
    "Region": [
      {
        "LocalName": "华东2（上海）",
        "RegionName": "华东2（上海）",
        "RegionEndpoint": "pvtz.aliyuncs.com",
        "RegionId": "cn-beijing"
      }
    ]
  }
}

Error response

JSON format

{
    "Message": "The request processing has failed due to some unknown error, exception or failure", 
    "RequestId": "E246E023-F2EB-4034-83F7-B13FCF31459C", 
    "Code": "InternalError"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.