All Products
Search
Document Center

Global Accelerator:ListBasicAccelerators

Last Updated:Mar 26, 2024

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
ga:ListBasicAcceleratorsList
  • BasicAccelerator
    acs:ga:{#regionId}:{#accountId}:ga/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region to which the basic GA instance belongs. Set the value to cn-hangzhou.

cn-hangzhou
PageNumberintegerNo

The page number. Default value: 1.

1
PageSizeintegerNo

The number of entries per page. Valid values: 1 to 50. Default value: 10.

10
AcceleratorIdstringNo

The ID of the basic GA instance.

ga-bp17frjjh0udz4qz****
StatestringNo

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
ResourceGroupIdstringNo

The ID of the resource group to which the basic GA instance belongs.

rg-aekzrnd67gq****
Tagobject []No

The tags of the GA instance.

KeystringNo

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
ValuestringNo

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

ParameterTypeDescriptionExample
object
TotalCountinteger

The total number of basic GA instances returned.

1
PageSizeinteger

The number of entries returned per page.

10
RequestIdstring

The ID of the request.

54B48E3D-DF70-471B-AA93-08E683A1B45
Acceleratorsobject []

The information about basic GA instances.

Typestring

This parameter is invalid.

None
Statestring

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
CreateTimelong

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
BasicBandwidthPackageobject

Details about the basic bandwidth plan that is associated with the basic GA instance.

Bandwidthinteger

The bandwidth value of the basic bandwidth plan. Unit: Mbit/s.

2
BandwidthTypestring

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

  • Basic: basic
  • Enhanced: enhanced
  • Advanced: premium
Basic
InstanceIdstring

The ID of the basic bandwidth plan.

gbwp-bp1d8xk8bg139j0fw****
RegionIdstring

The ID of the region where the basic GA instance is deployed.

cn-hangzhou
InstanceChargeTypestring

The billing method of the basic GA instance. Only PREPAY is returned, which indicates the subscription billing method.

PREPAY
AcceleratorIdstring

The ID of the basic GA instance.

ga-bp17frjjh0udz4qz****
Descriptionstring

The description of the basic GA instance.

BasicAccelerator
ExpiredTimelong

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
Namestring

The name of the basic GA instance.

BasicAccelerator
CrossDomainBandwidthPackageobject

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).

Bandwidthinteger

The bandwidth value of the cross-region acceleration bandwidth plan. Unit: Mbit/s.

2
InstanceIdstring

The ID of the cross-region acceleration bandwidth plan.

gbwp-bp1d8xk8bg139j0fw****
BasicEndpointGroupIdstring

The ID of the endpoint group that is associated with the basic GA instance.

epg-bp1dmlohjjz4kqaun****
BasicIpSetIdstring

The ID of the acceleration region where the basic GA instance is deployed.

ips-bp11ilwqjdkjeg9r7****
BandwidthBillingTypestring

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
ResourceGroupIdstring

The ID of the resource group to which the basic GA instance belongs.

rg-aekzrnd67gq****
Tagsobject []

The tags of the basic GA instance.

Keystring

The tag key of the basic GA instance.

Keytest
Valuestring

The tag value of the basic GA instance.

Valuetest
CrossBorderStatusboolean

Indicates whether cross-border acceleration is enabled for the GA instance. Valid values:

  • true
  • false
false
PageNumberinteger

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 codeError codeError messageDescription
500UnknownErrorAn 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 timeSummary of changesOperation
2023-07-20The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 500
2023-04-06The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 500
Output ParametersThe response structure of the API has changed.