Queries one or more bandwidth packages under an account.

Make the API call

You can use OpenAPI Explorer to make API calls, search for API calls, perform debugging, and generate SDK example code.

Request parameters

Parameter Type Required? Example value Description
Action String No DescribeCenBandwidthPackages

The name of this action. Value: DescribeCenBandwidthPackages
IncludeReservationData Boolean No true

Indicates whether to include renewal data. Valid values:

  • true: Return renewal data in the response.
  • false: Do not return renewal data in the response.
PageNumber Integer No 1

The page number. Default value: 1
PageSize Integer No 2

The number of entries per page in the case of a paged query result. Maximum value: 50. Default value: 10
Filter.N.Key String No status

The filter key (filter condition). You can specify up to five filter keys. The following filter keys are supported.

  • CenId: Cloud Enterprise Network (CEN) instance ID
  • Status: bandwidth package status. Valid values: Idle/InUse
  • CenBandwidthPackageId: bandwidth package ID
  • Name: bandwidth package name
Filter.N.Value.N RepeatList No Idle

The value of the filter key. You can specify multiple values for a filter key. These values are of the OR relation, which means that this filter condition is met when one of the specified values is matched.

IsOrKey Boolean No false

The relationship between filter keys. Valid values:

  • false (default): The filter keys are of the AND relation, which means that a bandwidth package is returned only when it matches all the filter conditions.
  • true: The filter keys are of the OR relation, which means that a bandwidth package is returned as long as it matches one of the filter conditions.

Response parameters

Parameter Type Example value Description
RequestId String 9D7E2400-2755-4AF5-9B73-12565E4F73A0

The ID of the request.
TotalCount Integer 2

The number of total entries.
PageNumber Integer 1

The current page number.
PageSize Integer 2

The number of entries per page.
CenBandwidthPackages Array

Details of the bandwidth packages.
CenBandwidthPackageId String cenbwp-4c2zaavbvh5x****

The ID of the bandwidth package.
Name String test

The name of the bandwidth package.
Description String cen

The description of the bandwidth package.
Bandwidth Long 2

The peak bandwidth of the bandwidth package.
BandwidthPackageChargeType String PREPAY

The billing method of the bandwidth package.
GeographicRegionAId String china

One of the connected areas of the bandwidth package.
GeographicRegionBId String north-america

The other connected area of the bandwidth package.
GeographicSpanId String north-america_china

The area ID of the cross-area connection.
BusinessStatus String Normal

The status of the bandwidth package.

  • Normal: Indicates that the bandwidth package is normal.
  • FinancialLocked: Indicates that the bandwidth package is locked due to an overdue payment.
  • SecurityLocked: Indicates that the bandwidth package is locked due to security reasons.
CreationTime String 2019-02-01T11:14Z

The time when the bandwidth package was created. This parameter takes the ISO 8601 format. Format: YYYY-MM-DDThh:mmZ

ExpiredTime String 2999-09-08T16:00Z

The time when the bandwidth package expires.
Status String InUse

The association status of the bandwidth package.

  • Idle: The bandwidth package is not associated with any CEN instance.
  • InUse: The bandwidth package is associated with one or more CEN instances.
IsCrossBorder Boolean false

Indicates whether the bandwidth package is a cross-border bandwidth package.

  • false: The bandwidth package is not a cross-border bandwidth package.
  • true: The bandwidth package is a cross-border bandwidth package.
TypeFor95 String 111
Ratio String 111
HasReservationData String false

Indicates whether renewal data is involved.

  • true: Renewal data is involved.
  • false: No renewal data is involved.
Note The value of this parameter is true only when the value of the parameter IncludeReservationData is true, and orders that have not taken effect exist.
ReservationBandwidth String 10

The restored bandwidth after the temporary upgrade.
ReservationInternetChargeType String PREPAY

The billing method after the configuration change.
ReservationActiveTime String 2018-08-30T16:00Z

The expiration time of the temporary upgrade.
ReservationOrderType String UPGRADE

The type of the configuration change.

  • TEMP_UPGRADE: Indicates a temporary upgrade.
  • UPGRADE: Indicates an upgrade.
OrginInterRegionBandwidthLimits Array

Details of the connected regions.
LocalRegionId String cn-hangzhou

The ID of the local region.
OppositeRegionId String us-west-1

The ID of the peer region.
GeographicSpanId String north-america_china

The area ID of the cross-area connection.
BandwidthLimit String 1

The peak bandwidth of the connected regions.
CenIds List cen-xxjsjfkffkfkfjkf****

The list of CEN instances that are associated with the bandwidth package.

Examples

Request example

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

Response example

XML format 

<DescribeCenBandwidthPackageResponse>
      <PageNumber>1</PageNumber>
      <TotalCount>5</TotalCount>
      <PageSize>10</PageSize>
      <RequestId>9D7E2400-2755-4AF5-9B73-12565E4F73A0</RequestId>
      <CenBandwidthPackages>
            <CenBandwidthPackage>
                  <CreationTime>2018-02-07T02:19Z</CreationTime>
                  <Status>InUse</Status>
                  <GeographicRegionBId>china</GeographicRegionBId>
                  <BusinessStatus>Normal</BusinessStatus>
                  <BandwidthPackageChargeType>PREPAY</BandwidthPackageChargeType>
                  <GeographicRegionAId>china</GeographicRegionAId>
                  <CenBandwidthPackageId>cenbwp-oq2ehpxq4zhwp7****</CenBandwidthPackageId>
                  <CenIds>
                        <CenId>cen-kojok19x3j0q6k****</CenId>
                  </CenIds>
                  <ExpiredTime>2018-03-07T16:00Z</ExpiredTime>
                  <Bandwidth>1</Bandwidth>
            </CenBandwidthPackage>
      </CenBandwidthPackages>
</DescribeCenBandwidthPackageResponse>

JSON format 

{
    "PageNumber": 1,
    "TotalCount": 5,
    "PageSize": 10,
    "RequestId": "9D7E2400-2755-4AF5-9B73-12565E4F73A0",
    "CenBandwidthPackages": {
        "CenBandwidthPackage": [
            {
                "CreationTime": "2018-02-07T02:19Z",
                "Status": "InUse",
                "GeographicRegionBId": "china",
                "BusinessStatus": "Normal",
                "BandwidthPackageChargeType": "PREPAY",
                "GeographicRegionAId": "china",
                "CenBandwidthPackageId": "cenbwp-oq2ehpxq4zhwp7****",
                "CenIds": {
                    "CenId": [
                        "cen-kojok19x3j0q6k****"
                    ]
                },
                "ExpiredTime": "2018-03-07T16:00Z",
                "Bandwidth": 1
            }
        ]
    }
}

Errors

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