Queries bandwidth plans.

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 parameters

Parameter Type Required Example Description
Action String Yes ListBandwidthPackages

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

RegionId String Yes cn-hangzhou

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

PageNumber Integer No 1

The number of the page to return. Default value: 1.

PageSize Integer No 10

The number of entries to return on each page. Maximum value: 100. Default value: 10.

State String No 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.
Type String No Basic

The type of the bandwidth plan. Valid values:

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

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

BandwidthPackageId String No gbwp-bp1sgzldyj6b4q7cx****

The ID of the bandwidth plan.

Response parameters

Parameter Type Example Description
TotalCount Integer 10

The total number of entries returned.

PageSize Integer 10

The number of entries returned per page.

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

The ID of the request.

PageNumber Integer 1

The page number of the returned page.

BandwidthPackages Array of BandwidthPackage

The details of the returned bandwidth plans.

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 created on the China site (aliyun.com) .

BandwidthType String Basic

The type of the bandwidth. Valid values:

  • Basic: basic bandwidth
  • Enhanced: enhanced bandwidth
  • Advanced: premium bandwidth
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.
CreateTime String 1578966918000

The time that indicates when the bandwidth plan was created.

ChargeType String PREPAY

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

RegionId String cn-hangzhou

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

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).

BandwidthPackageId String gbwp-bp1sgzldyj6b4q7cx****

The ID of the bandwidth plan.

Bandwidth Integer 2

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

Description String testDescription

The description of the bandwidth plan.

ExpiredTime String 1578966918000

The timestamp that indicates when the bandwidth plan expires.

Accelerators Array of String ga-bp1qe94o52ot4pkfn****

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

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).

Name String testName

The name of the bandwidth plan.

BillingType String PayByTraffic

The metering method. Valid values:

  • PayByTraffic: pay-by-data-transfer
  • PayBY95: pay-by-95th-percentile-bandwidth
Ratio Integer 30

The percentage of the 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=ListBandwidthPackages
&RegionId=cn-hangzhou
&PageNumber=1
&PageSize=10
&State=active
&Type=Basic
&BandwidthPackageId=gbwp-bp1sgzldyj6b4q7cx****
&<Common request parameters>

Sample success responses

XML format 

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

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

JSON format 

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

{
  "TotalCount" : 10,
  "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
  } ]
}

Error codes

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