ListBandwidthackages - Global Accelerator - Alibaba Cloud Documentation Center

Queries a list of bandwidth plans.

Operation description

This operation is deprecated. Use ListBandwidthPackages instead.

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:ListBandwidthackages

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the Global Accelerator instance. Set the value to cn-hangzhou.	cn-hangzhou
PageNumber	integer	No	The page number of the list. The default value is 1.	1
PageSize	integer	No	The number of entries to return on each page. Maximum value: 100. Default value: 10.	10

Response elements

Element	Type	Description	Example
	object	The response parameters.
TotalCount	integer	The total number of entries returned.	1
PageSize	integer	The number of entries on each page.	10
RequestId	string	The request ID.	4B6DBBB0-2D01-4C6A-A384-4129266E6B78
PageNumber	integer	The current page number.	1
BandwidthPackages	array<object>	The details of the bandwidth plans.
	array<object>	The details of the bandwidth plans.
BandwidthPackageId	string	The ID of the bandwidth plan.	gbwp-bp1sgzldyj6b4q7cx****
Bandwidth	integer	The bandwidth of the bandwidth plan. Unit: Mbps.	2
Description	string	The description of the bandwidth plan.	testDescription
ExpiredTime	string	The timestamp that indicates when the bandwidth plan expires.	1578966918000
State	string	The status of the bandwidth plan. init: The bandwidth plan is being initialized. active: The bandwidth plan is available. binded: The bandwidth plan is bound. binding: The bandwidth plan is being bound. unbinding: The bandwidth plan is being unbound. updating: The bandwidth plan is being updated. finacialLocked: The bandwidth plan is financially locked. locked: The bandwidth plan is locked.	active
CreateTime	string	The timestamp that indicates when the bandwidth plan was created.	1578966918000
ChargeType	string	The billing method. PREPAY (default): subscription. POSTPAY: pay-as-you-go.	PREPAY
Accelerators	array	The IDs of the Global Accelerator instances that are associated with the bandwidth plan.
	string	The ID of the Global Accelerator instance that is associated with the bandwidth plan.	ga-bp1qe94o52ot4pkfn****
Name	string	The name of the bandwidth plan.	Accelerator
RegionId	string	The ID of the region.	DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6
ResourceGroupId	string	The ID of the resource group.	rg-aekzzwgr7vz2liy
Tags	array<object>	The tags of the resource.
	object
Key	string	The tag key.	tag-key
Value	string	The tag value.	tag-value

Examples

Success response

JSON format

{
  "TotalCount": 1,
  "PageSize": 10,
  "RequestId": "4B6DBBB0-2D01-4C6A-A384-4129266E6B78",
  "PageNumber": 1,
  "BandwidthPackages": [
    {
      "BandwidthPackageId": "gbwp-bp1sgzldyj6b4q7cx****",
      "Bandwidth": 2,
      "Description": "testDescription",
      "ExpiredTime": "1578966918000",
      "State": "active",
      "CreateTime": "1578966918000",
      "ChargeType": "PREPAY",
      "Accelerators": [
        "ga-bp1qe94o52ot4pkfn****"
      ],
      "Name": "Accelerator",
      "RegionId": "DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6",
      "ResourceGroupId": "rg-aekzzwgr7vz2liy",
      "Tags": [
        {
          "Key": "tag-key",
          "Value": "tag-value"
        }
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.