Queries EIP bandwidth plans in a specific region.

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
Action String Yes DescribeCommonBandwidthPackages

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

IncludeReservationData Boolean No false

Specifies whether to return the pending orders. Valid values:

  • false: no. This is the default value.
  • true: yes
RegionId String Yes cn-hangzhou

The region ID of the EIP bandwidth plan.

You can call the DescribeRegions operation to query the most recent region list.

BandwidthPackageId String No cbwp-2ze2ic1xd2qeqk145****

The ID of the EIP bandwidth plan.

ResourceGroupId String No rg-acfmxazb4ph****

The ID of the resource group.

Name String No test123

The name of the EIP bandwidth plan.

PageNumber Integer No 1

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

PageSize Integer No 10

The number of entries to return on each page. Maximum value: 50. Default value: 10.

DryRun Boolean No false

Specifies whether to only precheck the request. Valid values:

  • true: checks the request only. The operation is not performed after the request passes the precheck. Check items include the request format, instance status, and whether the required parameters are specified. If the request fails to pass the precheck, the corresponding error message is returned. If the request passes the precheck, the DryRunOperation error code is returned.
  • false (default): sends the API request. If the request passes the precheck, a 2xx HTTP status code is returned and the operation is performed.
SecurityProtectionEnabled Boolean No false

Specifies whether to enable Anti-DDoS Pro/Premium. Valid values:

  • false (default): disables Anti-DDoS Pro/Premium.
  • true: enables Anti-DDoS Pro/Premium.

Response parameters

Parameter Type Example Description
PageSize Integer 10

The number of entries returned per page.

RequestId String 20E6FD1C-7321-4DAD-BDFD-EC8769E4AA33

The ID of the request.

PageNumber Integer 1

The page number of the returned page.

TotalCount Integer 1

The number of entries returned.

CommonBandwidthPackages Array of CommonBandwidthPackage

The details of the EIP bandwidth plan.

CommonBandwidthPackage
ReservationActiveTime String 2018-08-30T16:00:00Z

The time when the renewal takes effect. The time is displayed in YYYY-MM-DDThh:mm:ssZ format.

Status String Available

The status of the EIP bandwidth plan. Default value: Available.

CreationTime String 2017-06-28T06:39:20Z

The time when the EIP bandwidth plan was created. The time follows the YYYY-MM-DDThh:mm:ssZ format.

ReservationOrderType String RENEWCHANGE

The renewal method. Valid values:

  • RENEWCHANGE: renewal with upgrade or downgrade
  • TEMP_UPGRADE: temporary upgrade
  • UPGRADE: upgrade
DeletionProtection Boolean true

Indicates whether deletion protection is enabled. Valid values:

  • true: enabled
  • false: disabled
ReservationInternetChargeType String PayByBandwidth

The new billing method.

Ratio Integer 20

The percentage of the minimum bandwidth commitment. 20 is returned.

Note This parameter is available only on the Alibaba Cloud China site.
InstanceChargeType String PostPaid

The billing method of the EIP bandwidth plan.

PostPaid (pay-as-you-go) is returned.

RegionId String cn-hangzhou

The region ID of the EIP bandwidth plan.

BandwidthPackageId String cbwp-bp1t3sm1ffzmshdki****

The ID of the EIP bandwidth plan.

ServiceManaged Integer 1

Indicates whether the resource is created by the service account. Valid values:

  • 0: no
  • 1: yes
Bandwidth String 20

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

Description String none

The description of the EIP bandwidth plan.

ExpiredTime String 2019-01-15T03:08:37Z

The time when the EIP bandwidth plan expires. The time follows the YYYY-MM-DDThh:mm:ssZ format.

ReservationBandwidth String 1000

The new maximum bandwidth. Unit: Mbit/s.

ResourceGroupId String rg-acfmxazb4ph****

The ID of the resource group.

InternetChargeType String PayByBandwidth

The metering method of the EIP bandwidth plan. Valid values:

  • PayBy95: pay-by-enhanced-95th-percentile
  • PayByBandwidth: pay-by-bandwidth
BusinessStatus String Normal

The status of the EIP bandwidth plan. Valid values:

  • Normal: The EIP bandwidth plan works as expected.
  • FinancialLocked: The EIP bandwidth plan has an overdue payment.
  • Unactivated: The EIP bandwidth plan is not activated.
Name String abc

The name of the EIP bandwidth plan.

ISP String BGP

The line type. Valid values:

  • BGP: BGP (Multi-ISP)
  • BGP_PRO: BGP (Multi-ISP) Pro
HasReservationData String false

Indicates whether pending orders are returned. Valid values:

  • false: no
  • true: yes
PublicIpAddresses Array of PublicIpAddresse

The elastic IP addresses (EIPs) associated with the EIP bandwidth plan.

PublicIpAddresse
IpAddress String 47.95.XX.XX

The public IP address.

AllocationId String eip-bp13e9i2qst4g6jzi****

The ID of the EIP.

BandwidthPackageIpRelationStatus String BINDED

Indicates whether the EIP is associated with the EIP bandwidth plan. Valid values:

  • BINDED: associated
  • BINDING: associating
SecurityProtectionTypes Array of String AntiDDoS_Enhanced

The edition of Anti-DDoS. Valid values:

  • If this parameter is empty, it indicates that Anti-DDoS Origin is enabled.
  • If AntiDDoS_Enhanced is returned, it indicates that Anti-DDoS Pro/Premium is enabled.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeCommonBandwidthPackages
&IncludeReservationData=false
&RegionId=cn-hangzhou
&BandwidthPackageId=cbwp-2ze2ic1xd2qeqk145****
&ResourceGroupId=rg-acfmxazb4ph****
&Name=test123
&PageNumber=1
&PageSize=10
&DryRun=false
&SecurityProtectionEnabled=false
&Common request parameters

Sample success responses

XML format

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

<DescribeCommonBandwidthPackagesResponse>
    <PageSize>10</PageSize>
    <RequestId>20E6FD1C-7321-4DAD-BDFD-EC8769E4AA33</RequestId>
    <PageNumber>1</PageNumber>
    <TotalCount>1</TotalCount>
    <CommonBandwidthPackages>
        <ReservationActiveTime>2018-08-30T16:00:00Z</ReservationActiveTime>
        <Status>Available</Status>
        <CreationTime>2017-06-28T06:39:20Z</CreationTime>
        <ReservationOrderType>RENEWCHANGE</ReservationOrderType>
        <DeletionProtection>true</DeletionProtection>
        <ReservationInternetChargeType>PayByBandwidth</ReservationInternetChargeType>
        <Ratio>20</Ratio>
        <InstanceChargeType>PostPaid</InstanceChargeType>
        <RegionId>cn-hangzhou</RegionId>
        <BandwidthPackageId>cbwp-bp1t3sm1ffzmshdki****</BandwidthPackageId>
        <ServiceManaged>1</ServiceManaged>
        <Bandwidth>20</Bandwidth>
        <Description>none</Description>
        <ExpiredTime>2019-01-15T03:08:37Z</ExpiredTime>
        <ReservationBandwidth>1000</ReservationBandwidth>
        <ResourceGroupId>rg-acfmxazb4ph****</ResourceGroupId>
        <InternetChargeType>PayByBandwidth</InternetChargeType>
        <BusinessStatus>Normal</BusinessStatus>
        <Name>abc</Name>
        <ISP>BGP</ISP>
        <HasReservationData>false</HasReservationData>
        <PublicIpAddresses>
            <IpAddress>47.95.XX.XX</IpAddress>
            <AllocationId>eip-bp13e9i2qst4g6jzi****</AllocationId>
            <BandwidthPackageIpRelationStatus>BINDED</BandwidthPackageIpRelationStatus>
        </PublicIpAddresses>
        <SecurityProtectionTypes>AntiDDoS_Enhanced</SecurityProtectionTypes>
    </CommonBandwidthPackages>
</DescribeCommonBandwidthPackagesResponse>

JSON format

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

{
  "PageSize" : 10,
  "RequestId" : "20E6FD1C-7321-4DAD-BDFD-EC8769E4AA33",
  "PageNumber" : 1,
  "TotalCount" : 1,
  "CommonBandwidthPackages" : [ {
    "ReservationActiveTime" : "2018-08-30T16:00:00Z",
    "Status" : "Available",
    "CreationTime" : "2017-06-28T06:39:20Z",
    "ReservationOrderType" : "RENEWCHANGE",
    "DeletionProtection" : true,
    "ReservationInternetChargeType" : "PayByBandwidth",
    "Ratio" : 20,
    "InstanceChargeType" : "PostPaid",
    "RegionId" : "cn-hangzhou",
    "BandwidthPackageId" : "cbwp-bp1t3sm1ffzmshdki****",
    "ServiceManaged" : 1,
    "Bandwidth" : "20",
    "Description" : "none",
    "ExpiredTime" : "2019-01-15T03:08:37Z",
    "ReservationBandwidth" : "1000",
    "ResourceGroupId" : "rg-acfmxazb4ph****",
    "InternetChargeType" : "PayByBandwidth",
    "BusinessStatus" : "Normal",
    "Name" : "abc",
    "ISP" : "BGP",
    "HasReservationData" : "false",
    "PublicIpAddresses" : [ {
      "IpAddress" : "47.95.XX.XX",
      "AllocationId" : "eip-bp13e9i2qst4g6jzi****",
      "BandwidthPackageIpRelationStatus" : "BINDED"
    } ],
    "SecurityProtectionTypes" : [ "AntiDDoS_Enhanced" ]
  } ]
}

Error codes

HttpCode Error code Error message Description
400 InvalidBandwidthPackageIdNumber.NotSupported The number of BandwidthPackageIds exceeds the limit. The error message returned because the number of EIP bandwidth plans has reached the upper limit.
400 InvalidResourceGroupId The specified ResourceGroupId does not exist. The error message returned because the specified resource group ID is invalid.
400 OperationUnsupported.ResourceGroupId ResourceGroup is not supported in this region. The error message returned because the resource group feature is disabled.
404 InvalidRegionId.NotFound The specified RegionId does not exist in our records. The error message returned because the specified region ID does not exist.

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