All Products
Search
Document Center

Global Accelerator:ListAccelerators

Last Updated:May 16, 2024

Queries Global Accelerator (GA) instances.

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:ListAcceleratorsList
  • Accelerator
    acs:ga:{#regionId}:{#accountId}:ga/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region where the GA instance is deployed. Set the value to cn-hangzhou.

cn-hangzhou
PageNumberintegerNo

The page number. Default value: 1.

1
PageSizeintegerNo

The number of entries per page. Maximum value: 50. Default value: 10.

10
AcceleratorIdstringNo

The ID of the GA instance.

ga-bp1odcab8tmno0hdq****
StatestringNo

The status of the GA instance. Valid values:

  • init: The GA instance is being initialized.
  • active: The GA instance is available.
  • configuring: The GA instance is being configured.
  • binding: The GA instance is being associated.
  • unbinding: The GA instance is being disassociated.
  • deleting: The GA instance is being deleted.
  • finacialLocked: The GA instance is locked due to overdue payments.
active
ResourceGroupIdstringNo

The ID of the resource group.

rg-aekztkx4zwc****
Tagobject []No

The tags of the GA instance.

KeystringNo

The tag key of the GA resource. The tag key cannot be an empty string.

The tag key can be up to 64 characters in length and cannot contain http:// or https://. It cannot start with aliyun or acs:.

You can specify up to 20 tag keys.

tag-key
ValuestringNo

The tag value of the GA resource. The tag value can be an empty string.

The tag value can be up to 128 characters in length and cannot contain http:// or https://. It cannot start with aliyun or acs:.

You can specify up to 20 tag values.

tag-value

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

TotalCountinteger

The total number of entries returned.

10
PageSizeinteger

The number of entries returned per page.

10
RequestIdstring

The ID of the request.

DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6
Acceleratorsobject []

The information about the GA instances.

DnsNamestring

The CNAME that is assigned to the GA instance.

ga-bp15u1i2hmtbk8c3i****.aliyunga0019.com
Typestring

An invalid parameter.

Invalid parameter
SecondDnsNamestring

The CNAME that is used to associate the GA instance with an Anti-DDoS Pro instance or an Anti-DDOS Premium instance.

ga-bp1f609c76zg6zuna****-1.aliyunga0047.com
Specstring

The specification of the GA instance. Valid values:

  • 1: Small Ⅰ.
  • 2: Small Ⅱ.
  • 3: Small Ⅲ.
  • 5: Medium Ⅰ.
  • 8: Medium Ⅱ.
  • 10: Medium Ⅲ.
  • 20: Large Ⅰ.
  • 30: Large Ⅱ.
  • 40: Large Ⅲ.
  • 50: Large IV.
  • 60: Large V.
  • 70: Large VI.
  • 80: Large VII.
  • 90: Large VIII.
  • 100: Super Large Ⅰ.
  • 200: Super Large Ⅱ.
Note The Large Ⅲ specification and higher specifications are available only to accounts that are added to the whitelist. To use these specifications, contact your Alibaba Cloud account manager.

Different specifications provide different capabilities. For more information, see Instance specifications.

1
Statestring

The status of the GA instance. Valid values:

  • init: The GA instance is being initialized.
  • active: The GA instance is available.
  • configuring: The GA instance is being configured.
  • binding: The GA instance is being associated.
  • unbinding: The GA instance is being disassociated.
  • deleting: The GA instance is being deleted.
  • finacialLocked: The GA instance is locked due to overdue payments.
active
CreateTimelong

The timestamp that indicates when the GA instance was created.

1650643200
CenIdstring

The ID of the Cloud Enterprise Network (CEN) instance that is associated with the GA instance.

cen-hjfufhjfuwff****
DdosIdstring

The ID of the Anti-DDoS Pro or Anti-DDOS Premium instance that is associated with the GA instance.

ddoscoo-cn-zz11vq7j****
BasicBandwidthPackageobject

The information about the basic bandwidth plan that is associated with the GA instance.

Bandwidthinteger

The bandwidth value of the basic bandwidth plan. Unit: Mbit/s.

2
BandwidthTypestring

The bandwidth type that is provided by the basic bandwidth plan. Valid values:

  • Basic
  • Enhanced
  • Advanced
Basic
InstanceIdstring

The ID of the basic bandwidth plan.

gbwp-bp1d8xk8bg139j0fw****
RegionIdstring

The ID of the region where GA instance is deployed. Only cn-hangzhou may be returned.

cn-hangzhou
InstanceChargeTypestring

The billing method of the GA instance.

PREPAY
AcceleratorIdstring

The ID of the GA instance.

ga-bp1odcab8tmno0hdq****
Descriptionstring

The description of the GA instance.

Accelerator
Bandwidthinteger

The bandwidth of the GA instance. Unit: Mbit/s.

5
BandwidthBillingTypestring

The bandwidth metering method. Valid values:

  • BandwidthPackage: billed based on bandwidth plans.
  • CDT: billed based on data transfer.
CDT
ExpiredTimelong

The timestamp that indicates when the GA instance expires.

1653235200
Namestring

The name of the GA instance.

Accelerator
CrossDomainBandwidthPackageobject

The information about the cross-border acceleration bandwidth plan that is associated with the GA instance.

This array is returned only for GA instances that are created on the international site (alibabacloud.com).

Bandwidthinteger

The bandwidth value of the cross-border acceleration bandwidth plan. Unit: Mbit/s.

2
InstanceIdstring

The ID of the cross-border acceleration bandwidth plan.

gbwp-bp1d8xk8bg139j0fw****
IpSetConfigobject

The configurations of the acceleration area.

AccessModestring

The access mode of the acceleration area. Valid values:

  • UserDefine: custom nearby access mode. You can select acceleration areas and regions based on your business requirements. GA allocates a separate elastic IP address (EIP) to each acceleration region.
  • Anycast: automatic nearby access mode. You do not need to specify an acceleration area. GA allocates an Anycast EIP to multiple regions across the globe. Users can connect to the nearest access point of the Alibaba Cloud global transmission network by sending requests to the Anycast EIP.
UserDefine
ResourceGroupIdstring

The ID of the resource group.

rg-aekztkx4zwc****
Tagsobject []

The tags that are added to the resource.

Keystring

The key of the tag.

test-key
Valuestring

The value of the tag.

tast-value
CrossBorderModestring

The type of cross-border acceleration. This parameter is returned for GA instances whose bandwidth metering method is pay-by-data-transfer.

  • bpgPro: BGP (Multi-ISP) Pro lines.
  • private: cross-border Express Connect circuit.
bpgPro
CrossBorderStatusboolean

Indicates whether cross-border acceleration is enabled for the GA instance. Valid values:

  • true
  • false
false
UpgradableStatusstring

Indicates whether the GA instance can be upgraded. Valid values:

  • notUpgradable: The GA instance does not need to be upgraded.
  • upgradable: The GA instance can be upgraded to the latest version.
  • upgradeFailed: The GA instance failed to be upgraded.
notUpgradable
ServiceIdstring

The ID of the service that manages the instance.

Note This parameter takes effect only if the value of ServiceManaged is true.
ALB
ServiceManagedboolean

Indicates whether the GA instance is managed. Valid values:

  • true
  • false
true
ServiceManagedInfosobject []

The actions that users can perform on the managed instance.

Note
  • This parameter takes effect only if the value of ServiceManaged is true.
  • Users can perform only specific actions on a managed instance.
  • Actionstring

    The name of the action that is performed on the managed instance. Valid values:

    • Create
    • Update
    • Delete
    • Associate
    • UserUnmanaged
    • CreateChild
    Update
    ChildTypestring

    The type of the child resource. Valid values:

    • Listener: listener.
    • IpSet: acceleration region.
    • EndpointGroup: endpoint group.
    • ForwardingRule: forwarding rule.
    • Endpoint: endpoint.
    • EndpointGroupDestination: protocol mapping of an endpoint group associated with a custom routing listener.
    • EndpointPolicy: traffic policy of an endpoint associated with a custom routing listener.
    Note This parameter takes effect only if the value of Action is CreateChild.
    Listener
    IsManagedboolean

    Indicates whether the specified actions are managed. Valid values:

    • true: The specified actions are managed, and users cannot perform the specified actions on the managed instance.
    • false: The specified actions are not managed, and users can perform the specified actions on the managed instance.
    false
    PageNumberinteger

    The page number of the returned page.

    1

    Examples

    Sample success responses

    JSONformat

    {
      "TotalCount": 10,
      "PageSize": 10,
      "RequestId": "DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6",
      "Accelerators": [
        {
          "DnsName": "ga-bp15u1i2hmtbk8c3i****.aliyunga0019.com",
          "Type": "Invalid parameter\n",
          "SecondDnsName": "ga-bp1f609c76zg6zuna****-1.aliyunga0047.com",
          "Spec": "1",
          "State": "active",
          "CreateTime": 1650643200,
          "CenId": "cen-hjfufhjfuwff****",
          "DdosId": "ddoscoo-cn-zz11vq7j****",
          "BasicBandwidthPackage": {
            "Bandwidth": 2,
            "BandwidthType": "Basic",
            "InstanceId": "gbwp-bp1d8xk8bg139j0fw****"
          },
          "RegionId": "cn-hangzhou",
          "InstanceChargeType": "PREPAY",
          "AcceleratorId": "ga-bp1odcab8tmno0hdq****",
          "Description": "Accelerator",
          "Bandwidth": 5,
          "BandwidthBillingType": "CDT",
          "ExpiredTime": 1653235200,
          "Name": "Accelerator",
          "CrossDomainBandwidthPackage": {
            "Bandwidth": 2,
            "InstanceId": "gbwp-bp1d8xk8bg139j0fw****"
          },
          "IpSetConfig": {
            "AccessMode": "UserDefine"
          },
          "ResourceGroupId": "rg-aekztkx4zwc****",
          "Tags": [
            {
              "Key": "test-key",
              "Value": "tast-value"
            }
          ],
          "CrossBorderMode": "bpgPro",
          "CrossBorderStatus": false,
          "UpgradableStatus": "notUpgradable",
          "ServiceId": "ALB",
          "ServiceManaged": true,
          "ServiceManagedInfos": [
            {
              "Action": "Update",
              "ChildType": "Listener",
              "IsManaged": false
            }
          ]
        }
      ],
      "PageNumber": 1
    }

    Error codes

    HTTP status codeError codeError messageDescription
    500UnknownErrorAn error occurred while processing your request. Please try again. If the error persists, please submit a ticket.An error occurred while the request was being processed. Try again later.

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

    Change history

    Change timeSummary of changesOperation
    2023-08-15The Error code has changed. The response structure of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 500
    Output ParametersThe response structure of the API has changed.
    2023-07-20The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 500
    2023-06-14The Error code has changed. The response structure of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 500
    Output ParametersThe response structure of the API has changed.
    2023-04-06The Error code has changed. The response structure of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 500
    Output ParametersThe response structure of the API has changed.