Queries the information about a specified bandwidth plan.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameter

Parameter Type Required Example Description
Action String Yes DescribeBandwidthPackage

The operation that you want to perform. Set the value to DescribeBandwidthPackage.

RegionId String Yes cn-hangzhou

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

BandwidthPackageId String Yes gbwp-bp1sgzldyj6b4q7cx****

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

Response parameters

Parameter Type Example Description
CbnGeographicRegionIdB String Global

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

This parameter is returned only for bandwidth plans that are created on the International site (alibabacloud.com).

CbnGeographicRegionIdA String China-mainland

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

This parameter is returned only for bandwidth plans that are created on the International site (alibabacloud.com).

Description String testDescription

The description of the bandwidth plan.

RequestId String 4B6DBBB0-2D01-4C6A-A384-4129266E6B78

The ID of the request.

CreateTime String 1578966918000

The timestamp that indicates when the bandwidth plan was created.

Name String testName

The name of the bandwidth plan.

BandwidthType String Basic

The type of the bandwidth. Valid values:

  • Basic: basic bandwidth
  • Enhanced: enhanced bandwidth
  • Advanced: premium bandwidth
Type String Basic

The type of the bandwidth plan. Valid values:

  • Basic: basic bandwidth plan
  • CrossDomain: cross-border acceleration bandwidth plan

Only Basic is returned for bandwidth plans that are created on the China site (aliyun.com).

Accelerators Array of String ga-bp1qe94o52ot4pkfn****

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

State String active

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.
ChargeType String PREPAY

The billing method of the bandwidth plan. Only PREPAY is returned, which indicates the subscription billing method.

Bandwidth Integer 2

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

ExpiredTime String 1578966918000

The timestamp that indicates when the bandwidth plan expires.

BandwidthPackageId String gbwp-bp1sgzldyj6b4q7cx****

The ID of the bandwidth plan.

RegionId String cn-hangzhou

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

BillingType String PayByTraffic

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-bandwidth
Ratio Integer 30

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

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeBandwidthPackage
&RegionId=cn-hangzhou
&BandwidthPackageId=gbwp-bp1sgzldyj6b4q7cx****
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeBandwidthPackageResponse>
    <CbnGeographicRegionIdB>Global</CbnGeographicRegionIdB>
    <CbnGeographicRegionIdA>China-mainland</CbnGeographicRegionIdA>
    <Description>testDescription</Description>
    <RequestId>4B6DBBB0-2D01-4C6A-A384-4129266E6B78</RequestId>
    <CreateTime>1578966918000</CreateTime>
    <Name>testName</Name>
    <BandwidthType>Basic</BandwidthType>
    <Type>Basic</Type>
    <Accelerators>ga-bp1qe94o52ot4pkfn****</Accelerators>
    <State>active</State>
    <ChargeType>PREPAY</ChargeType>
    <Bandwidth>2</Bandwidth>
    <ExpiredTime>1578966918000</ExpiredTime>
    <BandwidthPackageId>gbwp-bp1sgzldyj6b4q7cx****</BandwidthPackageId>
    <RegionId>cn-hangzhou</RegionId>
    <BillingType>PayByTraffic</BillingType>
    <Ratio>30</Ratio>
</DescribeBandwidthPackageResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

For a list of error codes, visit the API Error Center.