DescribeBandwidthPackage API Reference for Bandwidth Plans - Global Accelerator - Alibaba Cloud - Global Accelerator

Queries the details of a bandwidth plan by calling the DescribeBandwidthPackage 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:DescribeBandwidthPackage

get

*BandwidthPackage

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

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
BandwidthPackageId	string	Yes	The ID of the bandwidth plan to query.	gbwp-bp1sgzldyj6b4q7cx****

Response elements

Element	Type	Description	Example
	object	The response parameters.
CbnGeographicRegionIdB	string	The interconnected area B of the cross-border acceleration bandwidth plan. The value is returned only as Global. This parameter is returned only on the Chinese site (Chinese mainland).	Global
CbnGeographicRegionIdA	string	The interconnected area A of the cross-border acceleration bandwidth plan. The value is returned only as China-mainland (the Chinese mainland). This parameter is returned only on the Alibaba Cloud International Website (www.alibabacloud.com).	China-mainland
Description	string	The description of the bandwidth plan.	testDescription
RequestId	string	The request ID.	4B6DBBB0-2D01-4C6A-A384-4129266E6B78
CreateTime	string	The timestamp when the bandwidth plan was created.	1578966918000
Name	string	The name of the bandwidth plan.	testName
BandwidthType	string	The bandwidth type. Valid values: Basic: standard acceleration bandwidth. Enhanced: enhanced acceleration bandwidth. Advanced: premium acceleration bandwidth.	Basic
Type	string	The type of the bandwidth plan. Valid values: Basic: basic bandwidth plan. CrossDomain: cross-border acceleration bandwidth plan. Only Basic is returned on the Alibaba Cloud China Website (www.aliyun.com).	Basic
Accelerators	array	The instance ID of the Alibaba Cloud Global Accelerator (GA) instance attached to the bandwidth plan.
	string	The instance ID of the Alibaba Cloud Global Accelerator (GA) instance attached to the bandwidth plan.	ga-bp1qe94o52ot4pkfn****
State	string	The status of the bandwidth plan. Valid values: init: initialization. active: active. binded: attached. binding: being attached. unbinding: being disassociated. updating: being updated. finacialLocked: locked due to overdue payment. locked: locked.	active
ChargeType	string	The billing method. Valid values: PREPAY (default): subscription. POSTPAY: pay-as-you-go.	PREPAY
Bandwidth	integer	The bandwidth value of the bandwidth plan. Unit: Mbit/s.	2
ExpiredTime	string	The timestamp when the bandwidth plan expires.	1578966918000
BandwidthPackageId	string	The bandwidth plan ID.	gbwp-bp1sgzldyj6b4q7cx****
RegionId	string	The region ID of the Alibaba Cloud Global Accelerator (GA) instance. Set the value to cn-hangzhou.	cn-hangzhou
BillingType	string	The billable methods for the pay-as-you-go billing method. 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. Valid values: 30 to 100.	30
ResourceGroupId	string	The resource group ID.	rg-acfnvueepcihjiq
Tags	array<object>	The resource tags.
	object
Key	string	The tag key.	tag-key
Value	string	The tag value.	tag-value

Examples

Success response

JSON format

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