DescribeCommonBandwidthPackages -

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 information about pending orders. Valid values: false (default) true
RegionId	String	Yes	cn-hangzhou	The region ID of the Internet Shared Bandwidth instance. You can call the DescribeRegions operation to query the most recent region list.
BandwidthPackageId	String	No	cbwp-2ze2ic1xd2qeqk145****	The ID of the Internet Shared Bandwidth instance.
ResourceGroupId	String	No	rg-acfmxazb4ph****	The ID of the resource group.
Name	String	No	test123	The name of the Internet Shared Bandwidth instance.
PageNumber	Integer	No	1	The page number. Default value: 1.
PageSize	Integer	No	10	The number of entries per page. Maximum value: 50. Default value: 10.
DryRun	Boolean	No	false	Specifies whether to perform only a dry run, without performing the actual request. Valid values: true: performs only a dry run. The system checks the request for potential issues, including required parameters, request syntax, and instance status. If the request fails the dry run, an error code is returned. If the request passes the dry run, the `DryRunOperation` error code is returned. false (default): performs a dry run and sends the request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.
Tag.N.Key	String	No	KeyTest	The key of tag N to add to the resource. You can specify at most 20 tag keys. The tag key cannot be an empty string. The tag key can be at most 128 characters in length. It cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`.
Tag.N.Value	String	No	ValueTest	The value of tag N to add to the resource. You can specify at most 20 tag values. The tag value can be an empty string. The tag value can be up to 128 characters in length, and cannot contain `http://` or `https://`. The tag value cannot start with `aliyun` or `acs:`.
SecurityProtectionEnabled	Boolean	No	false	Specifies whether to enable Anti-DDoS Pro/Premium. Valid values: false (default) true

Response parameters

Parameter	Type	Example	Description
PageSize	Integer	10	The number of entries per page.
RequestId	String	20E6FD1C-7321-4DAD-BDFD-EC8769E4AA33	The request ID.
PageNumber	Integer	1	The page number.
TotalCount	Integer	1	The number of entries returned.
CommonBandwidthPackages	Array of CommonBandwidthPackage		The details of the Internet Shared Bandwidth instance.
CommonBandwidthPackage
ReservationActiveTime	String	2018-08-30T16:00:00Z	The time when the renewal took effect. The time is displayed in the `YYYY-MM-DDThh:mm:ssZ` format.
Status	String	Available	The status of the Internet Shared Bandwidth instance. Valid values: Available Modifying
CreationTime	String	2017-06-28T06:39:20Z	The time when the Internet Shared Bandwidth instance was created. The time is displayed in the `YYYY-MM-DDThh:mm:ssZ` format.
ReservationOrderType	String	RENEWCHANGE	The renewal method. RENEWCHANGE TEMP_UPGRADE UPGRADE
DeletionProtection	Boolean	true	Indicates whether deletion protection is enabled. true false
ReservationInternetChargeType	String	PayByBandwidth	The new metering method. PayByTraffic: pay-by-data-transfer.
Ratio	Integer	20	The percentage of the minimum bandwidth commitment. Only 20 may be returned. Note This parameter is available only on the Alibaba Cloud China site.
InstanceChargeType	String	PostPaid	The billing method of the Internet Shared Bandwidth instance. Valid values: PostPaid: pay-as-you-go.
RegionId	String	cn-hangzhou	The region ID of the Internet Shared Bandwidth instance.
BandwidthPackageId	String	cbwp-bp1t3sm1ffzmshdki****	The ID of the Internet Shared Bandwidth instance.
ServiceManaged	Integer	1	Indicates whether the Internet Shared Bandwidth instance is created by the service account. 0: no 1: yes
Bandwidth	String	20	The maximum bandwidth of the Internet Shared Bandwidth instance. Unit: Mbit/s.
Description	String	none	The description of the Internet Shared Bandwidth instance.
ExpiredTime	String	2019-01-15T03:08:37Z	The time when the Internet Shared Bandwidth instance expired. The time is displayed in 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 Internet Shared Bandwidth instance. Valid values: PayByTraffic: pay-by-data-transfer.
BusinessStatus	String	Normal	The service status of the Internet Shared Bandwidth instance. Valid values: Normal FinancialLocked Unactivated
Name	String	abc	The name of the Internet Shared Bandwidth instance.
ISP	String	BGP	The line type. Valid values: BGP BGP (Multi-ISP) lines are available in all regions. BGP_PRO BGP (Multi-ISP) Pro lines are available in the China (Hong Kong), Singapore, Japan (Tokyo), Philippines (Manila), Malaysia (Kuala Lumpur), Indonesia (Jakarta), and Thailand (Bangkok) regions. If you are allowed to use single-ISP bandwidth, one of the following values is returned: ChinaTelecom ChinaUnicom ChinaMobile ChinaTelecom_L2 ChinaUnicom_L2 ChinaMobile_L2 If your services are deployed in China East 1 Finance, BGP_FinanceCloud is returned.
HasReservationData	String	false	Indicates whether the information about pending orders is returned. Valid values: false true
PublicIpAddresses	Array of PublicIpAddresse		The EIPs that are associated with the Internet Shared Bandwidth instance.
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 Internet Shared Bandwidth instance. Valid values: BINDED BINDING
SecurityProtectionTypes	Array of String	AntiDDoS_Enhanced	The edition of Anti-DDoS. If this parameter is empty, Anti-DDoS Origin Basic is enabled. If AntiDDoS_Enhanced is returned, Anti-DDoS Pro/Premium is enabled.
Tags	Array of Tag		The tag list.
Tag
Key	String	KeyTest	The tag key added to the Internet Shared Bandwidth instance.
Value	String	ValueTest	The tag value added to the Internet Shared Bandwidth instance.
BizType	String	CloudBox	The service type of the Internet Shared Bandwidth instance. CloudBox Only cloud box users can select this type. Default (default)
Zone	String	ap-southeast-1-lzdvn-cb	The zone of the Internet Shared Bandwidth instance. This parameter is returned only if the service type is CloudBox. If the service type is Default, an empty value is returned.

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
&Tag=[{"Key":"KeyTest","Value":"ValueTest"}]
&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>
        <Tags>
            <Key>KeyTest</Key>
            <Value>ValueTest</Value>
        </Tags>
        <BizType>CloudBox</BizType>
        <Zone>ap-southeast-1-lzdvn-cb</Zone>
    </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" ],
    "Tags" : [ {
      "Key" : "KeyTest",
      "Value" : "ValueTest"
    } ],
    "BizType" : "CloudBox",
    "Zone" : "ap-southeast-1-lzdvn-cb"
  } ]
}

Error codes

HttpCode	Error code	Error message	Description
400	InvalidBandwidthPackageIdNumber.NotSupported	The number of BandwidthPackageIds exceeds the limit.	The number of Internet Shared Bandwidth instances has exceeded the quota.
400	InvalidResourceGroupId	The specified ResourceGroupId does not exist.	The resource group ID is not found.
400	OperationUnsupported.ResourceGroupId	ResourceGroup is not supported in this region.	The resource group feature is disabled.
404	InvalidRegionId.NotFound	The specified RegionId does not exist in our records.	The region ID is not found.

For a list of error codes, see Service error codes.