Query bandwidth plans by calling the ListBandwidthPackages API - Global Accelerator - Alibaba Cloud - Global Accelerator

Queries the list of bandwidth plans by calling the ListBandwidthPackages operation.

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

list

*BandwidthPackage

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the Alibaba Cloud Global Accelerator (GA) instance. Set the value to cn-hangzhou.	cn-hangzhou
PageNumber	integer	No	The page number of the list. Default value: 1.	1
PageSize	integer	No	The number of entries per page when using paging. Maximum value: 100. Default value: 10.	10
State	string	No	The status of the bandwidth plan. Valid values: init: initialization. active: active. binded: The bandwidth plan is attached. binding: The bandwidth plan is being attached. unbinding: The bandwidth plan is being disassociated. updating: The bandwidth plan is being updated. finacialLocked: locked due to overdue payment. locked: The bandwidth plan is locked.	active
Type	string	No	The type of the bandwidth plan. Valid values: Basic: a basic bandwidth plan. CrossDomain: a cross-border acceleration bandwidth plan. China site only supports the value Basic.	Basic
BandwidthPackageId	string	No	The ID of the bandwidth plan.	gbwp-bp1sgzldyj6b4q7cx****
ResourceGroupId	string	No	The ID of the resource group.	rg-aek2ry6mp2c****
Tag	array<object>	No	The tags of the bandwidth plan.
	object	No	The tags of the bandwidth plan.
Key	string	No	The tag key of the bandwidth plan. If you specify this parameter, the value cannot be an empty string. The tag key can be up to 64 characters in length and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`. You can specify up to 20 tag keys.	tag-key
Value	string	No	The tag value of the bandwidth plan. If you specify this parameter, the value can be an empty string. The tag value can be up to 128 characters in length and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`. You can specify up to 20 tag values.	tag-value

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 per 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.
Type	string	The type of the bandwidth plan. Basic: a basic bandwidth plan. CrossDomain: a cross-border acceleration bandwidth plan. China site only returns Basic.	Basic
BandwidthType	string	The bandwidth type. Valid values: Basic: standard acceleration bandwidth. Enhanced: enhanced acceleration bandwidth. Advanced: premium acceleration bandwidth.	Basic
State	string	The status of the bandwidth plan. init: initialization. active: active. binded: The bandwidth plan is attached. binding: The bandwidth plan is being attached. unbinding: The bandwidth plan is being disassociated. updating: The bandwidth plan is being updated. finacialLocked: locked due to overdue payment. locked: The bandwidth plan is locked.	active
CreateTime	string	The time when the bandwidth plan was created.	1578966918000
ChargeType	string	The billing method. Valid values: PREPAY (default): subscription. POSTPAY: pay-as-you-go.	PREPAY
RegionId	string	The region ID of the Alibaba Cloud Global Accelerator (GA) instance. Only cn-hangzhou is returned.	cn-hangzhou
CbnGeographicRegionIdA	string	The interconnection area A of the cross-border acceleration bandwidth plan. Only China-mainland is returned. This parameter is returned only on the Alibaba Cloud International Website (www.alibabacloud.com).	China-mainland
BandwidthPackageId	string	The ID of the bandwidth plan.	gbwp-bp1sgzldyj6b4q7cx****
Bandwidth	integer	The bandwidth value of the bandwidth plan. Unit: Mbit/s.	2
Description	string	The description of the bandwidth plan.	testDescription
ExpiredTime	string	The timestamp that indicates when the bandwidth plan expires.	1578966918000
Accelerators	array	The instance ID of the Alibaba Cloud Global Accelerator (GA) instance that is attached to the bandwidth plan.
	string	The instance ID of the Alibaba Cloud Global Accelerator (GA) instance that is attached to the bandwidth plan.	ga-bp1qe94o52ot4pkfn****
CbnGeographicRegionIdB	string	The interconnection area B of the cross-border acceleration bandwidth plan. Only Global is returned. This parameter is returned only on the international site.	Global
Name	string	The name of the bandwidth plan.	testName
BillingType	string	The billing method for pay-as-you-go. Valid values: PayByTraffic: pay-by-data-transfer. PayBY95: pay-by-95th-percentile.	PayByTraffic
Ratio	integer	The minimum percentage for the pay-by-95th-percentile metering method.	30
ResourceGroupId	string	The ID of the resource group.	rg-aek2ry6mp2c****
Tags	array<object>	The tags of the bandwidth plan.
	object	The tags 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

Success response

JSON format

{
  "TotalCount": 1,
  "PageSize": 10,
  "RequestId": "4B6DBBB0-2D01-4C6A-A384-4129266E6B78",
  "PageNumber": 1,
  "BandwidthPackages": [
    {
      "Type": "Basic",
      "BandwidthType": "Basic",
      "State": "active",
      "CreateTime": "1578966918000",
      "ChargeType": "PREPAY",
      "RegionId": "cn-hangzhou",
      "CbnGeographicRegionIdA": "China-mainland",
      "BandwidthPackageId": "gbwp-bp1sgzldyj6b4q7cx****",
      "Bandwidth": 2,
      "Description": "testDescription",
      "ExpiredTime": "1578966918000",
      "Accelerators": [
        "ga-bp1qe94o52ot4pkfn****"
      ],
      "CbnGeographicRegionIdB": "Global",
      "Name": "testName",
      "BillingType": "PayByTraffic",
      "Ratio": 30,
      "ResourceGroupId": "rg-aek2ry6mp2c****",
      "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.