Queries Global Accelerator (GA) instances.

Debugging

Alibaba Cloud provides OpenAPI Explorer to simplify API usage. OpenAPI Explorer automatically calculates signature values. 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 your GA instances are 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 to query.

State String No active

The state of the GA instances to query. Valid values:

  • init: specifies the instances that are being initialized.
  • active: specifies the instances that are running.
  • configuring: specifies the instances for which listeners are being configured.
  • binding: specifies the instances to which bandwidth plans are being bound.
  • unbinding: specifies the instances from which bandwidth plans are being unbound.
  • Deleting: specifies the instances that are being deleted.
  • finacialLocked: specifies the instances that are locked due to overdue payments.

Response parameters

Parameter Type Example Description
TotalCount Integer 10

The total 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 returned GA instances.

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

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

Type String None

A deprecated 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 state of the GA instance. Valid values:

  • init: The instance is being initialized.
  • active: The instance is running.
  • configuring: A listener is being configured for the instance.
  • binding: A bandwidth plan is being bound to the instance.
  • unbinding: A bandwidth plan is being unbound from the instance.
  • Deleting: The instance is being deleted.
  • finacialLocked: The instance is locked due to overdue payments.
CreateTime Long 1577786252000

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

CenId String cen-hjfufhjfuwff****

The ID of the Cloud Enterprise Network 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 bound to the GA instance.

Bandwidth Integer 2

The bandwidth that is provided by the basic bandwidth plan. Unit: Mbit/s.

BandwidthType String Basic

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

  • Basic: the basic bandwidth
  • Enhanced: the enhanced bandwidth
  • Advanced: the advanced bandwidth
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. The value is cn-hangzhou.

InstanceChargeType String PREPAY

The billing method of the GA instance. The value is PREPAY. 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 1577786252000

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

Name String Accelerator

The name of the GA instance.

CrossDomainBandwidthPackage Object

The details of the cross-border bandwidth plan that is bound to the GA instance for cross-border acceleration.

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.

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 success 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>None</Type>
        <SecondDnsName>ga-bp1f609c76zg6zuna****-1.aliyunga0047.com</SecondDnsName>
        <Spec>1</Spec>
        <State>active</State>
        <CreateTime>1577786252000</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>1577786252000</ExpiredTime>
        <Name>Accelerator</Name>
        <CrossDomainBandwidthPackage>
            <Bandwidth>2</Bandwidth>
            <InstanceId>gbwp-bp1d8xk8bg139j0fw****</InstanceId>
        </CrossDomainBandwidthPackage>
    </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\t",
  "Accelerators" : [ {
    "DnsName" : "ga-bp1j80t5****.uisnetwork.com",
    "Type" : "None",
    "SecondDnsName" : "ga-bp1f609c76zg6zuna****-1.aliyunga0047.com",
    "Spec" : "1",
    "State" : "active",
    "CreateTime" : 1577786252000,
    "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" : 1577786252000,
    "Name" : "Accelerator",
    "CrossDomainBandwidthPackage" : {
      "Bandwidth" : 2,
      "InstanceId" : "gbwp-bp1d8xk8bg139j0fw****"
    }
  } ],
  "PageNumber" : 1
}

Error codes

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