Query basic Global Accelerator instances using ListBasicAccelerators - Global Accelerator - Alibaba Cloud - Global Accelerator

Queries a list of basic Global Accelerator (GA) instances.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ga:ListBasicAccelerators

list

*BasicAccelerator

acs:ga:{#regionId}:{#accountId}:ga/*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the basic GA instance. 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 tag key of tag N. 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 tag value of tag N. 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 elements

Element	Type	Description	Example
	object
TotalCount	integer	The total number of entries returned.	1
PageSize	integer	The number of entries returned per page.	10
RequestId	string	The request ID.	54B48E3D-DF70-471B-AA93-08E683A1B45
Accelerators	array<object>	The information about basic GA instances.
	array<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 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
CreateTime	integer	The timestamp that indicates when the basic GA instance was created. The value is a UNIX timestamp representing the number of seconds that have elapsed since 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 bandwidth type 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 (subscription) is returned.	PREPAY
AcceleratorId	string	The ID of the basic GA instance.	ga-bp17frjjh0udz4qz****
Description	string	The description of the basic GA instance.	BasicAccelerator
ExpiredTime	integer	The timestamp that indicates when the basic GA instance expires. The value is a UNIX timestamp representing the number of seconds that have elapsed since 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 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 based on data transfer through Cloud Data Transfer (CDT). CDT95: billed based on the 95th percentile bandwidth through CDT. This billing method is available only to users 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. Valid values: true false	false
PageNumber	integer	The page number of the returned page.	1

Examples

Success response

JSON format

{
  "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.