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 parameter

Parameter Type Required Example Description
Action String Yes ListBandwidthackages

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

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.

Response parameters

Parameter Type Example Description
TotalCount Integer 10

The total number of entries.

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 bandwidth plans.

BandwidthPackageId String gbwp-bp1sgzldyj6b4q7cx****

The ID of the bandwidth plan.

Bandwidth Integer 2

The bandwidth limit 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.

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

Accelerators Array of String ga-bp1qe94o52ot4pkfn****

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

Name String Accelerator

The name of the GA instance.

RegionId String DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListBandwidthackages
&RegionId=cn-hangzhou
&PageNumber=1
&PageSize=10
&<Common request parameters>

Sample success responses

XML format

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

<ListBandwidthackagesResponse>
    <TotalCount>10</TotalCount>
    <PageSize>10</PageSize>
    <RequestId>4B6DBBB0-2D01-4C6A-A384-4129266E6B78</RequestId>
    <PageNumber>1</PageNumber>
    <BandwidthPackages>
        <BandwidthPackageId>gbwp-bp1sgzldyj6b4q7cx****</BandwidthPackageId>
        <Bandwidth>2</Bandwidth>
        <Description>testDescription</Description>
        <ExpiredTime>1578966918000</ExpiredTime>
        <State>active</State>
        <CreateTime>1578966918000</CreateTime>
        <ChargeType>PREPAY</ChargeType>
        <Accelerators>ga-bp1qe94o52ot4pkfn****</Accelerators>
        <Name>Accelerator</Name>
        <RegionId>DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6</RegionId>
    </BandwidthPackages>
</ListBandwidthackagesResponse>

JSON format

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

{
  "TotalCount" : 10,
  "PageSize" : 10,
  "RequestId" : "4B6DBBB0-2D01-4C6A-A384-4129266E6B78",
  "PageNumber" : 1,
  "BandwidthPackages" : [ {
    "BandwidthPackageId" : "gbwp-bp1sgzldyj6b4q7cx****",
    "Bandwidth" : 2,
    "Description" : "testDescription",
    "ExpiredTime" : "1578966918000",
    "State" : "active",
    "CreateTime" : "1578966918000",
    "ChargeType" : "PREPAY",
    "Accelerators" : [ "ga-bp1qe94o52ot4pkfn****" ],
    "Name" : "Accelerator",
    "RegionId" : "DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6"
  } ]
}

Error codes

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