ListBasicAccelerators - Global Accelerator - Alibaba Cloud Documentation Center

Queries basic 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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
ga:ListBasicAccelerators	list	BasicAccelerator acs:ga:{#regionId}:{#accountId}:ga/*	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region to which the basic GA instance belongs. Set the value to cn-hangzhou.	cn-hangzhou
PageNumber	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Valid values: 1 to 50. Default value: 10.	10
AcceleratorId	string	No	The ID of the basic GA instance.	ga-bp17frjjh0udz4qz****
State	string	No	The state of the basic GA instance. Valid values: init: The basic GA instance is being initialized. active: The basic GA instance is available. configuring: The basic GA instance is being configured. binding: The basic GA instance is being associated. unbinding: The basic GA instance is being disassociated. deleting: The basic GA instance is being deleted. finacialLocked: The basic GA instance is locked due to overdue payments.	active
ResourceGroupId	string	No	The ID of the resource group to which the basic GA instance belongs.	rg-aekzrnd67gq****
Tag	array<object>	No	The tags of the GA instance.
	object	No
Key	string	No	The key of tag N of the basic GA instance. 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.	Keytest
Value	string	No	The value of tag N of the basic GA instance. 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.	Valuetest

Response parameters

Parameter	Type	Description	Example
	object
TotalCount	integer	The total number of basic GA instances returned.	1
PageSize	integer	The number of entries returned per page.	10
RequestId	string	The ID of the request.	54B48E3D-DF70-471B-AA93-08E683A1B45
Accelerators	array<object>	The information about basic GA instances.
	object
Type	string	This parameter is invalid.	None
State	string	The state of the basic GA instance. init: The basic GA instance is being initialized. active: The basic GA instance is available. configuring: The basic GA instance is being configured. binding: The basic GA instance is being associated. unbinding: The GA instance is being disassociated. deleting: The basic GA instance is being deleted. finacialLocked: The basic GA instance is locked due to overdue payments.	active
CreateTime	long	The timestamp that indicates when the basic GA instance was created. The time follows the UNIX time format. It is the number of seconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.	1637734547
BasicBandwidthPackage	object	Details about the basic bandwidth plan that is associated with the basic GA instance.
Bandwidth	integer	The bandwidth value of the basic bandwidth plan. Unit: Mbit/s.	2
BandwidthType	string	The type of the bandwidth that is provided by the basic bandwidth plan. Basic: basic Enhanced: enhanced Advanced: premium	Basic
InstanceId	string	The ID of the basic bandwidth plan.	gbwp-bp1d8xk8bg139j0fw****
RegionId	string	The ID of the region where the basic GA instance is deployed.	cn-hangzhou
InstanceChargeType	string	The billing method of the basic GA instance. Only PREPAY is returned, which indicates the subscription billing method.	PREPAY
AcceleratorId	string	The ID of the basic GA instance.	ga-bp17frjjh0udz4qz****
Description	string	The description of the basic GA instance.	BasicAccelerator
ExpiredTime	long	The timestamp that indicates when the basic GA instance expires. The time follows the UNIX time format. It is the number of seconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.	1640326547
Name	string	The name of the basic GA instance.	BasicAccelerator
CrossDomainBandwidthPackage	object	Details about the cross-region acceleration bandwidth plan that is associated with the GA instance. This parameter is returned only when you call this operation on the International site (alibabacloud.com).
Bandwidth	integer	The bandwidth value of the cross-region acceleration bandwidth plan. Unit: Mbit/s.	2
InstanceId	string	The ID of the cross-region acceleration bandwidth plan.	gbwp-bp1d8xk8bg139j0fw****
BasicEndpointGroupId	string	The ID of the endpoint group that is associated with the basic GA instance.	epg-bp1dmlohjjz4kqaun****
BasicIpSetId	string	The ID of the acceleration region where the basic GA instance is deployed.	ips-bp11ilwqjdkjeg9r7****
BandwidthBillingType	string	The bandwidth billing method. BandwidthPackage: billed based on bandwidth plans. CDT: billed through Cloud Data Transfer (CDT) and based on data transfer. CDT95: billed through CDT and based on the 95th percentile bandwidth. This bandwidth billing method is available only for users that are included in the whitelist.	BandwidthPackage
ResourceGroupId	string	The ID of the resource group to which the basic GA instance belongs.	rg-aekzrnd67gq****
Tags	array<object>	The tags of the basic GA instance.
	object
Key	string	The tag key of the basic GA instance.	Keytest
Value	string	The tag value of the basic GA instance.	Valuetest
CrossBorderStatus	boolean	Indicates whether cross-border acceleration is enabled for the GA instance. Valid values: true false	false
PageNumber	integer	The page number of the returned page.	1

Examples

Sample success responses

JSONformat

{
  "TotalCount": 1,
  "PageSize": 10,
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45",
  "Accelerators": [
    {
      "Type": "None",
      "State": "active",
      "CreateTime": 1637734547,
      "BasicBandwidthPackage": {
        "Bandwidth": 2,
        "BandwidthType": "Basic",
        "InstanceId": "gbwp-bp1d8xk8bg139j0fw****"
      },
      "RegionId": "cn-hangzhou",
      "InstanceChargeType": "PREPAY",
      "AcceleratorId": "ga-bp17frjjh0udz4qz****",
      "Description": "BasicAccelerator",
      "ExpiredTime": 1640326547,
      "Name": "BasicAccelerator",
      "CrossDomainBandwidthPackage": {
        "Bandwidth": 2,
        "InstanceId": "gbwp-bp1d8xk8bg139j0fw****"
      },
      "BasicEndpointGroupId": "epg-bp1dmlohjjz4kqaun****",
      "BasicIpSetId": "ips-bp11ilwqjdkjeg9r7****",
      "BandwidthBillingType": "BandwidthPackage",
      "ResourceGroupId": "rg-aekzrnd67gq****",
      "Tags": [
        {
          "Key": "Keytest",
          "Value": "Valuetest"
        }
      ],
      "CrossBorderStatus": false
    }
  ],
  "PageNumber": 1
}

Error codes

HTTP status code	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.	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 time	Summary of changes	Operation
2023-07-20	The Error code has changed	View Change Details
2023-04-06	The Error code has changed. The response structure of the API has changed	View Change Details