DescribeCenBandwidthPackages - API Reference| Alibaba Cloud Documentation Center

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.
PageNumber	Integer	No	The number of pages to return. Default value is `1`.
PageSize	Integer	No	The 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.
TotalCount	Integer	The number of queried entries.
PageSize	Integer	The number of entries on the current page.
CenBandwidthPackages	JSON String	A list of bandwidth packages.
The CenBandwidthPackages parameter contains the following elements:
CenBandwidthPackageId	String	The ID of the bandwidth package.
CenId	String	The ID of the CEN instance.
BusinessStatus	String	The 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

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

Response example

XML format

<?xml version="1.0" encoding="UTF-8"?>
<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-oq2ehpxq4zhwp790l7</CenBandwidthPackageId>
            <CenIds>
                <CenId>cen-kojok19x3j0q6kx5qf</CenId>
            </CenIds>
            <ExpiredTime>2018-03-07T16:00Z</ExpiredTime>
            <Bandwidth>1</Bandwidth>
        </CnBandwidthPackage>
    </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-oq2ehpxq4zhwp790l7",
            "CenIds":{
               "CenId":[
                  "cen-kojok19x3j0q6kx5qf"
               ]
            },
            "ExpiredTime":"2018-03-07T16:00Z",
            "Bandwidth":1
         }
      ]
   }
}