Use ListCommonAreas to query acceleration areas and regions - Global Accelerator - Alibaba Cloud - Global Accelerator

Operation description

This operation is used to query the available acceleration areas and regions for the intelligent recommendation and free trial on the Global Accelerator wizard page. You can filter results based on specified conditions.

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

ga:ListCommonAreas

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
IpVersion	string	No	The IP address protocol used to connect to Global Accelerator (GA). Valid values: IPv4 (default): IPv4 address protocol. Queries regions that support IPv4. IPv6: IPv6 address protocol. Queries regions that support IPv6.	IPv4
IsIpSet	boolean	No	Specifies whether the region is an acceleration area supported by Global Accelerator. true: Yes. false (default): No.	true
IsEpg	boolean	No	Specifies whether the region is an endpoint group region supported by Global Accelerator. true: Yes. false (default): No.	true

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6
Areas	array<object>	The area information.
	array<object>	The area information.
LocalName	string	The area name.	North China
AreaId	string	The area ID.	cn-huabei
RegionList	array<object>	The region list.
	object	The region list.
LocalName	string	The region name.	China (Qingdao)
RegionId	string	The region ID.	cn-qingdao

Examples

Success response

JSON format

{
  "RequestId": "DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6",
  "Areas": [
    {
      "LocalName": "North China",
      "AreaId": "cn-huabei",
      "RegionList": [
        {
          "LocalName": "China (Qingdao)",
          "RegionId": "cn-qingdao"
        }
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.