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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ListAccelerators

The operation that you want to perform. Set the value to ListAccelerators.

RegionId String Yes cn-hangzhou

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

PageNumber Integer No 1

The number of the page to return. Default value: 1.

PageSize Integer No 10

The number of entries to return on each page. Maximum value: 50. Default value: 10.

AcceleratorId String No ga-bp1odcab8tmno0hdq****

The ID of the GA instance that you want to query.

State String No active

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.

Response parameters

Parameter Type Example Description
TotalCount Integer 10

The number of entries returned.

PageSize Integer 10

The number of entries returned per page.

RequestId String DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6

The ID of the request.

Accelerators Array of Accelerators

The information about the GA instance that is queried.

DnsName String ga-bp1j80t5****.uisnetwork.com

The canonical name (CNAME) that is assigned to the GA instance.

Type String Invalid parameter

Indicates an invalid parameter.

SecondDnsName String ga-bp1f609c76zg6zuna****-1.aliyunga0047.com

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

Spec String 1

The specification of the GA instance. Valid values:

  • 1: Small I
  • 2: Small II
  • 3: Small III
  • 5: Medium I
  • 8: Medium II
  • 10: Medium III
State String active

The status of the GA instance.

  • 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.
CreateTime Long 1650643200

The timestamp that indicates the time when the GA instance was created.

CenId String cen-hjfufhjfuwff****

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

DdosId String ddoscoo-cn-zz11vq7j****

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

BasicBandwidthPackage Object

The details of the basic bandwidth plan that is associated with the GA instance.

Bandwidth Integer 2

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

BandwidthType String Basic

The type of the bandwidth that is provided by the basic bandwidth plan.

  • Basic: basic
  • Enhanced: enhanced
  • Advanced: premium
InstanceId String gbwp-bp1d8xk8bg139j0fw****

The ID of the basic bandwidth plan.

RegionId String cn-hangzhou

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

InstanceChargeType String PREPAY

The billing method of the GA instance. Only PREPAY is returned. This value indicates the subscription billing method.

AcceleratorId String ga-bp1odcab8tmno0hdq****

The ID of the GA instance.

Description String Accelerator

The description of the GA instance.

Bandwidth Integer 5

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

ExpiredTime Long 1653235200

The timestamp that indicates the time when the GA instance expires.

Name String Accelerator

The name of the GA instance.

CrossDomainBandwidthPackage Object

The details 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).

Bandwidth Integer 2

The bandwidth that is provided by the cross-border bandwidth plan for cross-border acceleration. Unit: Mbit/s.

InstanceId String gbwp-bp1d8xk8bg139j0fw****

The ID of the cross-border bandwidth plan.

IpSetConfig Object

The configurations of the acceleration area.

AccessMode String UserDefine

The access mode of the acceleration area. Valid values:

  • UserDefine: custom nearby access mode. You can select an acceleration area and region based on your business requirements. GA allocates a separate 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.
PageNumber Integer 1

The page number of the returned page.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListAccelerators
&RegionId=cn-hangzhou
&PageNumber=1
&PageSize=10
&AcceleratorId=ga-bp1odcab8tmno0hdq****
&State=active
&Common request parameters

Sample responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<ListAcceleratorsResponse>
    <TotalCount>10</TotalCount>
    <PageSize>10</PageSize>
    <RequestId>DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6</RequestId>
    <Accelerators>
        <DnsName>ga-bp1j80t5****.uisnetwork.com</DnsName>
        <Type>Invalid parameter</Type>
        <SecondDnsName>ga-bp1f609c76zg6zuna****-1.aliyunga0047.com</SecondDnsName>
        <Spec>1</Spec>
        <State>active</State>
        <CreateTime>1650643200</CreateTime>
        <CenId>cen-hjfufhjfuwff****</CenId>
        <DdosId>ddoscoo-cn-zz11vq7j****</DdosId>
        <BasicBandwidthPackage>
            <Bandwidth>2</Bandwidth>
            <BandwidthType>Basic</BandwidthType>
            <InstanceId>gbwp-bp1d8xk8bg139j0fw****</InstanceId>
        </BasicBandwidthPackage>
        <RegionId>cn-hangzhou</RegionId>
        <InstanceChargeType>PREPAY</InstanceChargeType>
        <AcceleratorId>ga-bp1odcab8tmno0hdq****</AcceleratorId>
        <Description>Accelerator</Description>
        <Bandwidth>5</Bandwidth>
        <ExpiredTime>1653235200</ExpiredTime>
        <Name>Accelerator</Name>
        <CrossDomainBandwidthPackage>
            <Bandwidth>2</Bandwidth>
            <InstanceId>gbwp-bp1d8xk8bg139j0fw****</InstanceId>
        </CrossDomainBandwidthPackage>
        <IpSetConfig>
            <AccessMode>UserDefine</AccessMode>
        </IpSetConfig>
    </Accelerators>
    <PageNumber>1</PageNumber>
</ListAcceleratorsResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalCount" : 10,
  "PageSize" : 10,
  "RequestId" : "DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6",
  "Accelerators" : [ {
    "DnsName" : "ga-bp1j80t5****.uisnetwork.com",
    "Type" : "Invalid parameter".
    "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,
    "ExpiredTime" : 1653235200,
    "Name" : "Accelerator",
    "CrossDomainBandwidthPackage" : {
      "Bandwidth" : 2,
      "InstanceId" : "gbwp-bp1d8xk8bg139j0fw****"
    },
    "IpSetConfig" : {
      "AccessMode" : "UserDefine"
    }
  } ],
  "PageNumber" : 1
}

Error codes

For a list of error codes, visit the API Error Center.