ListAccelerators -

Queries Global Accelerator (GA) instances that belong to your account.

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.
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.
ResourceGroupId	String	No	rg-aekztkx4zwc****	The ID of the resource group.
Tag.N.Key	String	No	tag-key	The tag key of the 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.N.Value	String	No	tag-value	The tag value of the resource. The tag value can be an empty string. The tag value can be up to 128 characters in length and cannot start with `acs:` or `aliyun`. The tag value cannot contain `http://` or `https://`. You can specify up to 20 tag values.

Response parameters


Parameter	Type	Example	Description
TotalCount	Integer	10	The total number of entries returned.
PageSize	Integer	10	The number of entries returned on each page.
RequestId	String	DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6	The request ID.
Accelerators	Array of Accelerators		The information about the GA instances.
DnsName	String	ga-bp15u1i2hmtbk8c3i****.aliyunga0019.com	The canonical name (CNAME) that is assigned to the GA instance.
Type	String	Invalid parameter	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/Premium instance.
Spec	String	1	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 Ⅳ 60: Large Ⅴ 70: Large Ⅵ 80: Large VⅡ 90: Large VⅢ 100: Super Large Ⅰ 200: Super Large Ⅱ Note GA instances Large III and above are not available by default. To use these instances , contact your Alibaba Cloud account manager. Each instance specification provides different capabilities. For more information, see Instance specifications.
State	String	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.
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/Premium instance that is associated with the GA instance.
BasicBandwidthPackage	Object		The details about 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. Valid values: Basic: standard 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. cn-hangzhou is returned.
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 value of the GA instance. Unit: Mbit/s.
BandwidthBillingType	String	CDT	The bandwidth billing method. BandwidthPackage: billed based on bandwidth plans. CDT: billed based on data transfer.
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-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 that is provided by the cross-region acceleration bandwidth plan. Unit: Mbit /s.
InstanceId	String	gbwp-bp1d8xk8bg139j0fw****	The ID of the cross-region acceleration 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 acceleration areas and regions 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.
ResourceGroupId	String	rg-aekztkx4zwc****	The ID of your Alibaba Cloud resource group.
Tags	Array of Tags		The tag of the instance.
Key	String	test-key	The tag key.
Value	String	tast-value	The tag value.
CrossBorderMode	String	bpgPro	The type of cross-border acceleration. This parameter is returned for pay-by-data-transfer GA instances whose billing is managed by Cloud Data Transfer (CDT). Valid values: bpgPro: BGP Pro lines
PageNumber	Integer	1	The 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
&ResourceGroupId=rg-aekztkx4zwc****
&Tag=[{"Key":"tag-key","Value":"tag-value"}]
&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-bp15u1i2hmtbk8c3i****.aliyunga0019.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>
        <BandwidthBillingType>CDT</BandwidthBillingType>
        <ExpiredTime>1653235200</ExpiredTime>
        <Name>Accelerator</Name>
        <CrossDomainBandwidthPackage>
            <Bandwidth>2</Bandwidth>
            <InstanceId>gbwp-bp1d8xk8bg139j0fw****</InstanceId>
        </CrossDomainBandwidthPackage>
        <IpSetConfig>
            <AccessMode>UserDefine</AccessMode>
        </IpSetConfig>
        <ResourceGroupId>rg-aekztkx4zwc****</ResourceGroupId>
        <Tags>
            <Key>test-key</Key>
            <Value>tast-value</Value>
        </Tags>
        <CrossBorderMode>bpgPro</CrossBorderMode>
    </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-bp15u1i2hmtbk8c3i****.aliyunga0019.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,
    "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"
  } ],
  "PageNumber" : 1
}

Error codes


HttpCode	Error code	Error message	Description
500	UnknownError	An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.	The error message returned because an error occurred when the request was being processed. Try again later.

For a list of error codes, see Service error codes.