All Products
Search
Document Center

Global Accelerator:DescribeBandwidthPackage

Last Updated:Jan 23, 2024

Queries information about a bandwidth plan.

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.
OperationAccess levelResource typeCondition keyAssociated operation
ga:DescribeBandwidthPackageREAD
  • BandwidthPackage
    acs:ga:{#regionId}:{#accountId}:bandwidthpackage/{#bandwidthPackageId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region where the Global Accelerator (GA) instance is deployed. Set the value to cn-hangzhou.

cn-hangzhou
BandwidthPackageIdstringYes

The ID of the bandwidth plan that you want to query.

gbwp-bp1sgzldyj6b4q7cx****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

CbnGeographicRegionIdBstring

Area B specified in the cross-region acceleration bandwidth plan. Only Global (global) is returned.

This parameter is returned only if you call this operation on the International site (alibabacloud.com).

Global
CbnGeographicRegionIdAstring

Area A specified in the cross-region acceleration bandwidth plan. Only China-mainland (the Chinese mainland) is returned.

This parameter is returned only if you call this operation on the International site (alibabacloud.com).

China-mainland
Descriptionstring

The description of the bandwidth plan.

testDescription
RequestIdstring

The ID of the request.

4B6DBBB0-2D01-4C6A-A384-4129266E6B78
CreateTimestring

The timestamp that indicates when the bandwidth plan was created.

1578966918000
Namestring

The name of the bandwidth plan.

testName
BandwidthTypestring

The type of the bandwidth. Valid values:

  • Basic: basic bandwidth
  • Enhanced: enhanced bandwidth
  • Advanced: premium bandwidth
Basic
Typestring

The type of the bandwidth plan. Valid values:

  • Basic: a basic bandwidth plan
  • CrossDomain: a cross-region acceleration bandwidth plan

If you call this operation on the Alibaba Cloud China Site (aliyun.com), only Basic is returned.

Basic
Acceleratorsarray

The ID of the GA instance that is associated with the bandwidth plan.

string

The ID of the GA instance that is associated with the bandwidth plan.

ga-bp1qe94o52ot4pkfn****
Statestring

The state 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.
  • unbinding: The bandwidth plan is being disassociated.
  • updating: The bandwidth plan is being updated.
  • finacialLocked: The bandwidth plan is locked due to overdue payments.
  • Locked: The bandwidth plan is locked.
active
ChargeTypestring

The billing method of the bandwidth plan.

  • PREPAY: subscription. This is the default value.
  • POSTPAY: pay-as-you-go.
PREPAY
Bandwidthinteger

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

2
ExpiredTimestring

The timestamp that indicates when the bandwidth plan expires.

1578966918000
BandwidthPackageIdstring

The ID of the bandwidth plan.

gbwp-bp1sgzldyj6b4q7cx****
RegionIdstring

The ID of the region where GA instance is deployed. cn-hangzhou is returned.

cn-hangzhou
BillingTypestring

The metering method that is used when you use the pay-as-you-go billing method. Valid values:

  • PayByTraffic: pay-by-data-transfer
  • PayBY95: pay-by-95th-percentile
PayByTraffic
Ratiointeger

The percentage of the minimum bandwidth guaranteed if the pay-by-95th-percentile-bandwidth metering method is used. Valid values: 30 to 100.

30
ResourceGroupIdstring

The ID of the resource group.

rg-acfnvueepcihjiq
Tagsobject []

Tag objects.

Keystring

The key of tag N that is added to the bandwidth plan.

tag-key
Valuestring

The value of tag N that is added to the bandwidth plan.

tag-value

Examples

Sample success responses

JSONformat

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

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

Change history

Change timeSummary of changesOperation
No change history