DescribeCenBandwidthPackages -

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	true	Specifies whether to include renewal data. Valid values: true: yes false: no
Action	String	Yes	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	2	The number of entries to return on each page. Maximum value: 50. Default value: 10.
IsOrKey	Boolean	No	false	The logical operator between the filter conditions. Valid values: false (default): AND Bandwidth plans that meet all filter conditions are returned. true: OR Bandwidth plans that meet one of the 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: CEN instance ID Status: bandwidth plan status. Valid values: Idle: not associated with a CEN instance. InUse: associated with a CEN instance. CenBandwidthPackageId: bandwidth plan ID Name: bandwidth plan name You can specify one or more filter conditions. The maximum value of N is 5.
Filter.N.Value.N	String	No	cen-xxjsjfkffkfkfjkf****	Specify a filter value based on the Key parameter. 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.

Response parameters


Parameter	Type	Example	Description
PageSize	Integer	2	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	2	The number of entries returned.
CenBandwidthPackages	Array of CenBandwidthPackage		The details about the bandwidth plan.
CenBandwidthPackage
ReservationActiveTime	String	2021-08-30T16:00Z	The expiration time of the temporary upgrade.
Status	String	InUse	Indicates whether the bandwidth plan is associated with a CEN instance. Idle: no InUse: yes
CreationTime	String	2021-02-01T11:14Z	The time when the bandwidth plan was created. The time is displayed in the ISO8601 standard in the YYYY-MM-DDThh:mmZ format.
ReservationOrderType	String	UPGRADE	The renewal method. TEMP_UPGRADE: temporary upgrade UPGRADE: upgrade
BandwidthPackageChargeType	String	PREPAY	The billing method of the bandwidth plan.
CenBandwidthPackageId	String	cenbwp-4c2zaavbvh5x****	The ID of the bandwidth plan.
ReservationInternetChargeType	String	PREPAY	The new billing method.
GeographicRegionAId	String	china	The ID of the area that you want to query. Valid values: china: Chinese mainland. asia-pacific: Asia Pacific europe: Europe australia: Australia north-america: North America
Bandwidth	Long	2	The maximum bandwidth of the bandwidth plan.
Description	String	cen	The description of the bandwidth plan.
ExpiredTime	String	2021-09-08T16:00Z	The timeout period of the bandwidth plan.
ReservationBandwidth	String	10	The bandwidth value to which the bandwidth plan is rolled back when the temporary upgrade ends.
GeographicSpanId	String	north-america_china	The ID of the connected area.
GeographicRegionBId	String	north-america	The ID of the other connected area of the bandwidth plan. Valid values: china: Chinese mainland. asia-pacific: Asia Pacific europe: Europe australia: Australia north-america: North America
IsCrossBorder	Boolean	false	Indicates whether the bandwidth plan is a cross-border bandwidth plan. false: no true: yes
BusinessStatus	String	Normal	The status of the bandwidth plan. Valid values: 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 renewal data is included. true: yes false: no Note This parameter returns true only when the IncludeReservationData parameter is set to true and an order has not taken effect.
OrginInterRegionBandwidthLimits	Array of OrginInterRegionBandwidthLimit		The details about the connected regions.
OrginInterRegionBandwidthLimit
BandwidthLimit	String	1	The maximum bandwidth value for the inter-region connection.
OppositeRegionId	String	us-west-1	The ID of the peer region.
GeographicSpanId	String	north-america_china	The connected regions.
LocalRegionId	String	cn-hangzhou	The ID of the source region.
CenIds	Array of String	cen-xxjsjfkffkfkfjkf****	A list of CEN instances that are associated with the bandwidth plan.

Examples

Sample requests

http(s)://[Endpoint]/?IncludeReservationData=true
&Action=DescribeCenBandwidthPackages
&PageNumber=1
&PageSize=2
&IsOrKey=false
&Filter=[{"Key":"CenId","Value":["cen-xxjsjfkffkfkfjkf****"]}]
&Common request parameters

Sample responses

XML format

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

<DescribeCenBandwidthPackagesResponse>
    <PageSize>2</PageSize>
    <RequestId>9D7E2400-2755-4AF5-9B73-12565E4F73A0</RequestId>
    <PageNumber>1</PageNumber>
    <TotalCount>2</TotalCount>
    <CenBandwidthPackages>
        <ReservationActiveTime>2021-08-30T16:00Z</ReservationActiveTime>
        <Status>InUse</Status>
        <CreationTime>2021-02-01T11:14Z</CreationTime>
        <ReservationOrderType>UPGRADE</ReservationOrderType>
        <BandwidthPackageChargeType>PREPAY</BandwidthPackageChargeType>
        <CenBandwidthPackageId>cenbwp-4c2zaavbvh5x****</CenBandwidthPackageId>
        <ReservationInternetChargeType>PREPAY</ReservationInternetChargeType>
        <GeographicRegionAId>china</GeographicRegionAId>
        <Bandwidth>2</Bandwidth>
        <Description>cen</Description>
        <ExpiredTime>2021-09-08T16:00Z</ExpiredTime>
        <ReservationBandwidth>10</ReservationBandwidth>
        <GeographicSpanId>north-america_china</GeographicSpanId>
        <GeographicRegionBId>north-america</GeographicRegionBId>
        <IsCrossBorder>false</IsCrossBorder>
        <BusinessStatus>Normal</BusinessStatus>
        <Name>test</Name>
        <HasReservationData>false</HasReservationData>
        <OrginInterRegionBandwidthLimits>
            <BandwidthLimit>1</BandwidthLimit>
            <OppositeRegionId>us-west-1</OppositeRegionId>
            <GeographicSpanId>north-america_china</GeographicSpanId>
            <LocalRegionId>cn-hangzhou</LocalRegionId>
        </OrginInterRegionBandwidthLimits>
        <CenIds>cen-xxjsjfkffkfkfjkf****</CenIds>
    </CenBandwidthPackages>
</DescribeCenBandwidthPackagesResponse>

JSON format

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

{
  "PageSize" : 2,
  "RequestId" : "9D7E2400-2755-4AF5-9B73-12565E4F73A0",
  "PageNumber" : 1,
  "TotalCount" : 2,
  "CenBandwidthPackages" : [ {
    "ReservationActiveTime" : "2021-08-30T16:00Z",
    "Status" : "InUse",
    "CreationTime" : "2021-02-01T11:14Z",
    "ReservationOrderType" : "UPGRADE",
    "BandwidthPackageChargeType" : "PREPAY",
    "CenBandwidthPackageId" : "cenbwp-4c2zaavbvh5x****",
    "ReservationInternetChargeType" : "PREPAY",
    "GeographicRegionAId" : "china",
    "Bandwidth" : 2,
    "Description" : "cen",
    "ExpiredTime" : "2021-09-08T16:00Z",
    "ReservationBandwidth" : "10",
    "GeographicSpanId" : "north-america_china",
    "GeographicRegionBId" : "north-america",
    "IsCrossBorder" : false,
    "BusinessStatus" : "Normal",
    "Name" : "test",
    "HasReservationData" : "false",
    "OrginInterRegionBandwidthLimits" : [ {
      "BandwidthLimit" : "1",
      "OppositeRegionId" : "us-west-1",
      "GeographicSpanId" : "north-america_china",
      "LocalRegionId" : "cn-hangzhou"
    } ],
    "CenIds" : [ "cen-xxjsjfkffkfkfjkf****" ]
  } ]
}

Error codes

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