edit-icon download-icon

DescribeCenBandwidthPackages

Last Updated: Apr 11, 2018

Description

Query the purchased bandwidth packages.

Request parameters

Name Type Required Description
Action String Yes

The action to perform. Valid value:

DescribeCenBandwidthPackages

Filter.n.Key String No

Filter keys. Up to 5 filters can be specified. Valid value for n is [1,5].

The supported filter keys are:

  • CenId: Query the bandwidth package with the specified CEN instance ID.
  • Name: Query the bandwidth package with the specified name.
  • CenBandwidthPackageId: Query the bandwidth package with the specified bandwidth package ID.
  • Status: Query the bandwidth package with the specified status (idle or InUse).
Filter.n.Value.m String No The value of the corresponding filter key.
PageNumberIntegerNoThe number of pages to return. Default value is 1.
PageSizeIntegerNoThe number of rows per page. The maximum value is 50 and the default value is 10.

Response parameters

Name Type Description
RequestId String The ID of the request.
PageNumber Integer The current page number.
TotalCountIntegerThe number of queried entries.
PageSizeIntegerThe number of entries on the current page.
CenBandwidthPackagesJSON StringA list of bandwidth packages.
The CenBandwidthPackages parameter contains the following elements:
CenBandwidthPackageId StringThe ID of the bandwidth package.
CenIdStringThe ID of the CEN instance.
BusinessStatusStringThe billing status of the bandwidth package, including Normal, FinancialLocked, and SecurityLocked.
Status String The status of the bandwidth package in the CEN instance, including Idle and InUse.
Bandwidth Integer The peak bandwidth of the bandwidth package.
CreationTime String The time at which the bandwidth package is created in the format of YYYY-MM-DDThh:mmZ.
BandwidthPackageChargeType String The billing method of the bandwidth package.
GeographicRegionAId String The interconnection area selected for the bandwidth package.
GeographicRegionBId String The other interconnection area selected for the bandwidth package.

Error codes

See Common error codes.

Examples

Request example

  1. http://cen.aliyuncs.com/?Action=DescribeCenBandwidthPackage
  2. &<Common parameters>

Response example

XML format

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <DescribeCenBandwidthPackageResponse>
  3. <PageNumber>1</PageNumber>
  4. <TotalCount>5</TotalCount>
  5. <PageSize>10</PageSize>
  6. <RequestId>9D7E2400-2755-4AF5-9B73-12565E4F73A0</RequestId>
  7. <CenBandwidthPackages>
  8. <CenBandwidthPackage>
  9. <CreationTime>2018-02-07T02:19Z</CreationTime>
  10. <Status>InUse</Status>
  11. <GeographicRegionBId>china</GeographicRegionBId>
  12. <BusinessStatus>Normal</BusinessStatus>
  13. <BandwidthPackageChargeType>PREPAY</BandwidthPackageChargeType>
  14. <GeographicRegionAId>china</GeographicRegionAId>
  15. <CenBandwidthPackageId>cenbwp-oq2ehpxq4zhwp790l7</CenBandwidthPackageId>
  16. <CenIds>
  17. <CenId>cen-kojok19x3j0q6kx5qf</CenId>
  18. </CenIds>
  19. <ExpiredTime>2018-03-07T16:00Z</ExpiredTime>
  20. <Bandwidth>1</Bandwidth>
  21. </CnBandwidthPackage>
  22. </DescribeCenBandwidthPackageResponse>

JSON format

  1. {
  2. "PageNumber":1,
  3. "TotalCount":5,
  4. "PageSize":10,
  5. "RequestId":"9D7E2400-2755-4AF5-9B73-12565E4F73A0",
  6. "CenBandwidthPackages":{
  7. "CenBandwidthPackage":[
  8. {
  9. "CreationTime":"2018-02-07T02:19Z",
  10. "Status":"InUse",
  11. "GeographicRegionBId":"china",
  12. "BusinessStatus":"Normal",
  13. "BandwidthPackageChargeType":"PREPAY",
  14. "GeographicRegionAId":"china",
  15. "CenBandwidthPackageId":"cenbwp-oq2ehpxq4zhwp790l7",
  16. "CenIds":{
  17. "CenId":[
  18. "cen-kojok19x3j0q6kx5qf"
  19. ]
  20. },
  21. "ExpiredTime":"2018-03-07T16:00Z",
  22. "Bandwidth":1
  23. }
  24. ]
  25. }
  26. }
Thank you! We've received your feedback.