调用DescribeCommonBandwidthPackages接口查询指定地域中共享带宽实例列表及其信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| vpc:DescribeCommonBandwidthPackages | get |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| IncludeReservationData | boolean | 否 | 是否包含未生效的订购数据。取值：
| false |
| RegionId | string | 是 | 共享带宽所在的地域 ID。 您可以通过调用 DescribeRegions 接口获取地域 ID。 | cn-hangzhou |
| BandwidthPackageId | string | 否 | 共享带宽实例的 ID。 | cbwp-2ze2ic1xd2qeqk145**** |
| ResourceGroupId | string | 否 | 资源组 ID。 | rg-acfmxazb4ph**** |
| Name | string | 否 | 共享带宽实例名称。
长度为 0-128 个字符，不能以 | test123 |
| PageNumber | integer | 否 | 列表的页码。默认值：1。 | 1 |
| PageSize | integer | 否 | 分页查询时每页的行数。最大值：50。默认值：10。 | 10 |
| DryRun | boolean | 否 | 是否只预检此次请求。取值：
| false |
| Tag | array<object> | 否 | 共享带宽实例的标签列表。 | |
| object | 否 | 共享带宽实例的标签列表。 | ||
| Key | string | 否 | 资源的标签键。最多支持输入 20 个标签键。如需传入该值，则不能输入空字符串。 一个标签键最多支持 128 个字符，不能以 | KeyTest |
| Value | string | 否 | 资源的标签值。最多支持输入 20 个标签值。如需传入该值，可以输入空字符串。 最多支持 128 个字符，不能以 | ValueTest |
| SecurityProtectionEnabled | boolean | 否 | 是否开启 DDoS 防护（增强版）。取值：
说明
该参数已废弃。
| false |
返回参数
示例
正常返回示例
JSON格式
{
"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"
}
]
}
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | InvalidBandwidthPackageIdNumber.NotSupported | The number of BandwidthPackageIds exceeds the limit. | 共享带宽包的数量超过Quota限制。 |
| 400 | InvalidResourceGroupId | The specified ResourceGroupId does not exist. | 资源组ID不存在。 |
| 400 | OperationUnsupported.ResourceGroupId | ResourceGroup is not supported in this region. | 资源组功能未打开。 |
| 404 | InvalidRegionId.NotFound | The specified RegionId does not exist in our records. | 指定的RegionId不存在。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2023-08-08 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-06-12 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
| 2023-05-17 | OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |