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
IncludeReservationData Boolean No false

Specifies whether to return data of orders that have not taken effect. Valid values:

  • true: yes
  • false (default): no
Action String No DescribeCenBandwidthPackages

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

PageNumber Integer No 1

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

PageSize Integer No 10

The number of entries to return per page. Default value: 10. Valid values: 1 to 50.

IsOrKey Boolean No false

The logical relation between filter conditions. Valid values:

  • true: The logical relation between filter conditions is OR. Bandwidth plans that meet one of the filter conditions are returned.
  • false (default): The logical relation between filter conditions is AND. Bandwidth plans that meet all filter conditions are returned.
Filter.N.Key String No CenId

The filter condition.

You can use filter conditions to filter the bandwidth plans that you want to query. The following filter conditions are supported:

  • CenId: the ID of a Cloud Enterprise Network (CEN) instance.
  • Status: the status of a bandwidth plan. Valid values:
    • Idle: not associated with a CEN instance.
    • InUse: associated with a CEN instance.
  • CenBandwidthPackageId: the ID of a bandwidth plan.
  • Name: the name of a bandwidth plan.

You can specify one or more filter conditions. The maximum value of N is 5.

Filter.N.Value.N String No cen-xxjsjfkffkfkfjkf****

The value of the filter key.

You can specify multiple values for a filter key. The logical relation among multiple filter values is OR. If a bandwidth package matches one of the values that you specify, the bandwidth package matches the filter condition. Maximum value of N: 5.

Response parameters

Parameter Type Example Description
PageSize Integer 10

The number of entries returned per page.

RequestId String 9D7E2400-2755-4AF5-9B73-12565E4F73A0

The ID of the request.

PageNumber Integer 1

The page number of the returned page.

TotalCount Integer 1

The total number of entries returned.

CenBandwidthPackages Array of CenBandwidthPackage

The information about the bandwidth plans.

CenBandwidthPackage
ReservationActiveTime String 2022-08-30T16:00Z

The time when the order that has not taken effect takes effect.

The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mmZ format. The time is displayed in UTC.

Status String InUse

The status of the bandwidth plan.

  • Idle: not associated with a CEN instance.
  • InUse: associated with a CEN instance.
CreationTime String 2021-02-01T11:14Z

The time when the bandwidth plan was created.

The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mmZ format. The time is displayed in UTC.

ReservationOrderType String UPGRADE

Indicates whether the order that has not taken effect is upgraded or renewed.

  • TEMP_UPGRADE: temporarily upgraded
  • UPGRADE: upgraded
  • RENEW: renewed
BandwidthPackageChargeType String PREPAY

The billing method of the bandwidth plan.

  • POSTPAY: pay-as-you-go
  • PREPAY: subscription
CenBandwidthPackageId String cenbwp-4c2zaavbvh5x****

The ID of the bandwidth plan.

ReservationInternetChargeType String PayByBandwidth

The billable items of the order that has not taken effect. Default value: PayByBandwidth, which indicates the pay-by-bandwidth metering method.

GeographicRegionAId String china

The ID of one of the connected areas of the bandwidth plan. Valid values:

  • China: mainland China
  • North-America: North America
  • Asia-Pacific: Asia Pacific
  • Europe: Europe
  • Australia: Australia
Bandwidth Long 1

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

Description String testdesc

The description of the bandwidth plan.

ExpiredTime String 2029-09-08T16:00Z

The expiration time of the bandwidth plan.

The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mmZ format. The time is displayed in UTC.

ReservationBandwidth String 10

The maximum bandwidth value of the order that has not taken effect. Unit: Mbit/s.

GeographicSpanId String north-america_china

The ID of the area combination of the bandwidth plan.

GeographicRegionBId String north-america

The ID of the other connected area of the bandwidth plan.

  • China: mainland China
  • North-America: North America
  • Asia-Pacific: Asia Pacific
  • Europe: Europe
  • Australia: Australia
IsCrossBorder Boolean false

Indicates whether the bandwidth plan is a bandwidth plan for cross-border communication.

  • false: no
  • true: yes
BusinessStatus String Normal

The business status of the bandwidth plan.

  • Normal: normal
  • FinancialLocked: locked due to overdue payments
  • SecurityLocked: locked due to security reasons
Name String test

The name of the bandwidth plan.

HasReservationData String false

Indicates whether information about orders that have not taken effect is returned. Valid values:

  • true: yes
  • false: no
Note true is returned only when IncludeReservationData is set to true and orders that have not taken effect exist.
OrginInterRegionBandwidthLimits Array of OrginInterRegionBandwidthLimit

The maximum bandwidth values for cross-region connections of the bandwidth plan.

OrginInterRegionBandwidthLimit
BandwidthLimit String 1

The maximum bandwidth value for the cross-region connection. Unit: Mbit/s.

OppositeRegionId String us-west-1

The ID of the peer region.

GeographicSpanId String north-america_china

The ID of the region combination.

LocalRegionId String cn-hangzhou

The ID of the local region.

You can call the DescribeRegions operation to query information about regions and their peer regions.

CenIds Array of String cen-xxjsjfkffkfkfjkf****

The CEN instances with which the bandwidth plan is associated.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeCenBandwidthPackages
&<Common request parameters>

Sample success responses

XML format

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

<DescribeCenBandwidthPackagesResponse>
    <PageNumber>1</PageNumber>
    <TotalCount>1</TotalCount>
    <PageSize>10</PageSize>
    <RequestId>9D7E2400-2755-4AF5-9B73-12565E4F73A0</RequestId>
    <CenBandwidthPackages>
        <CenBandwidthPackage>
            <CreationTime>2021-02-01T11:14Z</CreationTime>
            <GeographicSpanId>north-america_china</GeographicSpanId>
            <IsCrossBorder>false</IsCrossBorder>
            <HasReservationData>false</HasReservationData>
            <Status>InUse</Status>
            <GeographicRegionBId>north-america</GeographicRegionBId>
            <BusinessStatus>Normal</BusinessStatus>
            <BandwidthPackageChargeType>PREPAY</BandwidthPackageChargeType>
            <GeographicRegionAId>china</GeographicRegionAId>
            <CenBandwidthPackageId>cen-xxjsjfkffkfkfjkf****</CenBandwidthPackageId>
            <CenIds>
                <CenId>cen-kojok19x3j0q6k****</CenId>
            </CenIds>
            <ExpiredTime>2029-09-08T16:00Z</ExpiredTime>
            <Bandwidth>1</Bandwidth>
        </CenBandwidthPackage>
    </CenBandwidthPackages>
</DescribeCenBandwidthPackagesResponse>

JSON format

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

{
  "PageNumber" : 1,
  "TotalCount" : 1,
  "PageSize" : 10,
  "RequestId" : "9D7E2400-2755-4AF5-9B73-12565E4F73A0",
  "CenBandwidthPackages" : {
    "CenBandwidthPackage" : [ {
      "CreationTime" : "2021-02-01T11:14Z",
      "GeographicSpanId" : "north-america_china",
      "IsCrossBorder" : false,
      "HasReservationData" : false,
      "Status" : "InUse",
      "GeographicRegionBId" : "north-america",
      "BusinessStatus" : "Normal",
      "BandwidthPackageChargeType" : "PREPAY",
      "GeographicRegionAId" : "china",
      "CenBandwidthPackageId" : "cen-xxjsjfkffkfkfjkf****",
      "CenIds" : {
        "CenId" : [ "cen-kojok19x3j0q6k****" ]
      },
      "ExpiredTime" : "2029-09-08T16:00Z",
      "Bandwidth" : 1
    } ]
  }
}

Error codes

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