Queries a list of Internet Shared Bandwidth instances in a region.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| vpc:DescribeCommonBandwidthPackages | get | *CommonBandwidthPackage acs:vpc:{#regionId}:{#accountId}:combandwidthpackage/* |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| IncludeReservationData | boolean | No | Specifies whether to return the information about pending orders. Valid values:
| false |
| RegionId | string | Yes | The ID of the region where the Internet Shared Bandwidth instance resides. You can call the DescribeRegions operation to query the region ID. | cn-hangzhou |
| BandwidthPackageId | string | No | The ID of the Internet Shared Bandwidth instance. | cbwp-2ze2ic1xd2qeqk145**** |
| ResourceGroupId | string | No | The ID of the resource group. | rg-acfmxazb4ph**** |
| Name | string | No | The name of the Internet Shared Bandwidth instance. | test123 |
| PageNumber | integer | No | The page number. Default value: 1. | 1 |
| PageSize | integer | No | The number of entries per page. Valid values: 1 to 50. Default value: 10. | 10 |
| DryRun | boolean | No | Specifies whether to perform a dry run, without performing the actual request. Valid values:
| false |
| Tag | array<object> | No | The tags to add to the Internet Shared Bandwidth instance. | |
| object | No | |||
| Key | string | No | The tag key to add to the Internet Shared Bandwidth instance. You can specify up to 20 tag keys. The tag key cannot be an empty string. The tag key can be up to 128 characters in length. It cannot start with | KeyTest |
| Value | string | No | The tag value to add to the Internet Shared Bandwidth instance. You can specify up to 20 tag values. The tag value can be an empty string. The tag value can be up to 128 characters in length. It cannot start with | ValueTest |
| SecurityProtectionEnabled | boolean | No | Specifies whether to enable Anti-DDoS Pro/Premium. Valid values:
| false |
Response parameters
Examples
Sample success responses
JSONformat
{
"PageSize": 10,
"RequestId": "20E6FD1C-7321-4DAD-BDFD-EC8769E4AA33",
"PageNumber": 1,
"TotalCount": 1,
"CommonBandwidthPackages": {
"CommonBandwidthPackage": [
{
"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": {
"PublicIpAddresse": [
{
"IpAddress": "47.95.XX.XX",
"AllocationId": "eip-bp13e9i2qst4g6jzi****",
"BandwidthPackageIpRelationStatus": "BINDED"
}
]
},
"SecurityProtectionTypes": {
"SecurityProtectionType": [
"AntiDDoS_Enhanced"
]
},
"Tags": {
"Tag": [
{
"Key": "KeyTest",
"Value": "ValueTest"
}
]
},
"BizType": "CloudBox",
"Zone": "ap-southeast-1-lzdvn-cb"
}
]
}
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | InvalidBandwidthPackageIdNumber.NotSupported | The number of BandwidthPackageIds exceeds the limit. | The number of BandwidthPackageIds exceeds the limit. |
| 400 | InvalidResourceGroupId | The specified ResourceGroupId does not exist. | The specified resource group ID does not exist. |
| 400 | OperationUnsupported.ResourceGroupId | ResourceGroup is not supported in this region. | - |
| 404 | InvalidRegionId.NotFound | The specified RegionId does not exist in our records. | The specified region ID does not exist. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2023-08-08 | The Error code has changed. The response structure of the API has changed | View Change Details |
| 2023-06-12 | The Error code has changed. The request parameters of the API has changed | View Change Details |
| 2023-05-17 | API Description Update. The Error code has changed. The response structure of the API has changed | View Change Details |