Queries the information about a Global Accelerator (GA) instance.

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 DescribeAccelerator

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

RegionId String Yes cn-hangzhou

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

AcceleratorId String Yes ga-bp1odcab8tmno0hdq****

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

Response parameters

Parameter Type Example Description
DdosId String ddoscoo-cn-zz11vq7j****

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

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

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

Description String Accelerator

The description of the GA instance.

RequestId String 6FEA0CF3-D3B9-43E5-A304-D217037876A8

The ID of the request.

InstanceChargeType String PREPAY

The billing method of the GA instance.

CreateTime Long 1650643200

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

CrossDomainBandwidthPackage Object

The details about the cross-region 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 of the the cross-region bandwidth plan. Unit: Mbit/s.

InstanceId String gbwp-bp1d8xk8bg139j0fw****

The ID of the cross-region bandwidth plan.

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

The CNAME that is used to integrate the GA instance with the Anti-DDoS service.

Name String Accelerator

The name of the GA instance.

BasicBandwidthPackage Object

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

Bandwidth Integer 2

The bandwidth value 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.

State String active

The status of the GA instance that is queried. 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.
ExpiredTime Long 1653235200

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

CenId String cen-hjkduu767hc****

The ID of the Cloud Enterprise Network (CEN) instance to which the GA instance is attached.

RegionId String cn-hangzhou

The region ID of the GA 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
AcceleratorId String ga-bp1odcab8tmno0hdq****

The ID of the GA instance.

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.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeAccelerator
&RegionId=cn-hangzhou
&AcceleratorId=ga-bp1odcab8tmno0hdq****
&Common request parameters

Sample responses

XML format 

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

<DescribeAcceleratorResponse>
    <DdosId>ddoscoo-cn-zz11vq7j****</DdosId>
    <DnsName>ga-bp1j80t5****.uisnetwork.com</DnsName>
    <Description>Accelerator</Description>
    <RequestId>6FEA0CF3-D3B9-43E5-A304-D217037876A8    </RequestId>
    <InstanceChargeType>PREPAY</InstanceChargeType>
    <CreateTime>1650643200</CreateTime>
    <CrossDomainBandwidthPackage>
        <Bandwidth>2</Bandwidth>
        <InstanceId>gbwp-bp1d8xk8bg139j0fw****</InstanceId>
    </CrossDomainBandwidthPackage>
    <SecondDnsName>ga-bp1f609c76zg6zuna****-1.aliyunga0047.com</SecondDnsName>
    <Name>Accelerator</Name>
    <BasicBandwidthPackage>
        <Bandwidth>2</Bandwidth>
        <BandwidthType>Basic</BandwidthType>
        <InstanceId>gbwp-bp1d8xk8bg139j0fw****</InstanceId>
    </BasicBandwidthPackage>
    <State>active</State>
    <ExpiredTime>1653235200</ExpiredTime>
    <CenId>cen-hjkduu767hc****</CenId>
    <RegionId>cn-hangzhou</RegionId>
    <Spec>1</Spec>
    <AcceleratorId>ga-bp1odcab8tmno0hdq****</AcceleratorId>
    <IpSetConfig>
        <AccessMode>UserDefine</AccessMode>
    </IpSetConfig>
</DescribeAcceleratorResponse>

JSON format 

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

{
  "DdosId" : "ddoscoo-cn-zz11vq7j****",
  "DnsName" : "ga-bp1j80t5****.uisnetwork.com",
  "Description" : "Accelerator",
  "RequestId" : "6FEA0CF3-D3B9-43E5-A304-D217037876A8\t",
  "InstanceChargeType" : "PREPAY",
  "CreateTime" : 1650643200,
  "CrossDomainBandwidthPackage" : {
    "Bandwidth" : 2,
    "InstanceId" : "gbwp-bp1d8xk8bg139j0fw****"
  },
  "SecondDnsName" : "ga-bp1f609c76zg6zuna****-1.aliyunga0047.com",
  "Name" : "Accelerator",
  "BasicBandwidthPackage" : {
    "Bandwidth" : 2,
    "BandwidthType" : "Basic",
    "InstanceId" : "gbwp-bp1d8xk8bg139j0fw****"
  },
  "State" : "active",
  "ExpiredTime" : 1653235200,
  "CenId" : "cen-hjkduu767hc****",
  "RegionId" : "cn-hangzhou",
  "Spec" : "1",
  "AcceleratorId" : "ga-bp1odcab8tmno0hdq****",
  "IpSetConfig" : {
    "AccessMode" : "UserDefine"
  }
}

Error codes

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