All Products
Search
Document Center

Global Accelerator:ListCommonAreas

Last Updated:Jul 31, 2024

Queries available acceleration areas and regions.

Operation description

You can call this operation to query the acceleration areas and regions that you can specify on the wizard page of Global Accelerator (GA) and for free-trial GA instances. You can filter acceleration areas and regions based on specified conditions.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ga:ListCommonAreaslist
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
IpVersionstringNo

The IP version used to connect to the GA instance. Valid values:

  • IPv4 (default)
  • IPv6
IPv4
IsIpSetbooleanNo

Specifies whether to query regions supported by GA. Valid values:

  • true
  • false (default)
true
IsEpgbooleanNo

Specifies whether to query regions where endpoint groups of GA can be deployed. Valid values:

  • true: yes
  • false (default): no
true

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6
Areasarray<object>

The information about the areas.

object

The information about the areas.

LocalNamestring

The area name.

North China
AreaIdstring

The area ID.

cn-huabei
RegionListarray<object>

The information about the regions.

object

The information about the regions.

LocalNamestring

The region name.

China (Qingdao)
RegionIdstring

The region ID.

cn-qingdao

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history