ListBandwidthackages - Global Accelerator - Alibaba Cloud Documentation Center

Queries bandwidth plans.

Operation description

To query the detailed information about a bandwidth plan, call the ListBandwidthPackages operation. For more information, see ListBandwidthPackages .

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:ListBandwidthackages	List	BandwidthPackage acs:ga:{#regionId}:{#accountId}:bandwidthpackage/*	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the Global Accelerator (GA) instance is deployed. 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. Maximum value: 100. Default value: 10.	10

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
TotalCount	integer	The total number of entries returned.	1
PageSize	integer	The number of entries returned per page.	10
RequestId	string	The ID of the request.	4B6DBBB0-2D01-4C6A-A384-4129266E6B78
PageNumber	integer	The page number of the returned page.	1
BandwidthPackages	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: Mbit/s.	2
Description	string	The description of the bandwidth plan.	testDescription
ExpiredTime	string	The expiration time of the bandwidth plan.	1578966918000
State	string	The status of the bandwidth plan. Valid values: init: The bandwidth plan is being initialized. active: The bandwidth plan is available. binded: The bandwidth plan is associated with a GA instance. binding: The bandwidth plan is being associated with a GA instance. unbinding: The bandwidth plan is being disassociated from a GA instance. updating: The bandwidth plan is being updated. finacialLocked: The bandwidth plan is locked due to overdue payments. locked: The bandwidth plan is locked.	active
CreateTime	string	The time when the bandwidth plan was created.	1578966918000
ChargeType	string	The billing method of the bandwidth plan. Valid values: PREPAY: subscription. This is the default value. POSTPAY: pay-as-you-go.	PREPAY
Accelerators	array	The IDs of the GA instances that are associated with the bandwidth plans.
	string	The ID of the GA instance that is associated with the bandwidth plan.	ga-bp1qe94o52ot4pkfn****
Name	string	The name of the GA instance.	Accelerator
RegionId	string	The request ID.	DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6
ResourceGroupId	string	The ID of the resource group.	rg-aekzzwgr7vz2liy
Tags	object []	The tag of the bandwidth plan.
Key	string	The tag key of the bandwidth plan.	tag-key
Value	string	The tag value of the bandwidth plan.	tag-value

Examples

Sample success responses

JSONformat

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

For a list of error codes, visit the Service error codes.

Change history

Change time

Summary of changes

Operation

2023-07-20

The internal configuration of the API is changed, but the call is not affected

see changesets

Change item	Change content
	The internal configuration of the API is changed, but the call is not affected.