调用 DescribeBandwidthPackages 接口，查询满足指定条件的共享带宽包。
传入多个请求参数，按照传入的参数进行查询，返回符合所有条件的共享带宽包，若没有符合条件的共享带宽包，则返回空值。
若请求参数非必选参数均未传入，则按照当前登录账号查询，返回当前账号下的所有共享带宽包。
使用标签过滤共享带宽包实例时，最多可查询指定标签关联的1000个共享带宽包实例。如果指定标签关联的共享带宽包实例超过1000个，则请您使用 ListTagsForResources 接口查询。
参数名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | DescribeBandwidthPackages | 要执行的操作，取值：DescribeBandwidthPackages。 |
| Version | String | 是 | 2020-04-01 | API的版本信息，当前版本为2020-04-01。 |
BandwidthPackageIds.N | String | 否 | BandwidthPackageIds.1=bwp-2zeo05qre24nhrqpy**** | 要查询的共享带宽包实例ID。
|
| BandwidthPackageName | String | 否 | bwp-01 | 共享带宽包的名称。 |
ISP | string | 否 | BGP | 共享带宽包的线路类型。取值如下：
|
Protocol | String | 否 | IPv4 | 共享带宽包的IP协议，取值如下：
|
SecurityProtectionEnabled | Boolean | 否 | true | 共享带宽包的安全防护类型。
|
| ProjectName | String | 否 | Project_1 | 共享带宽包所属项目的名称。 |
TagFilters.N.Key | String | 否 | TagFilters.1.Key=k1&TagFilters.2.Key=k2&TagFilters.3.Key=k3 | 标签的标签键。
|
TagFilters.N.Values.N | String | 否 | TagFilters.1.Values.1=v1&TagFilters.1.Values.2=v2&TagFilters.3.Values.1=v1 | 标签的标签值。
说明
|
PageNumber | Integer | 否 | 1 | 列表的页码。默认值为1。 说明 本参数即将下线，建议您使用 |
PageSize | Integer | 否 | 20 | 分页查询时每页的行数。最大值为100，默认值为20。 说明 本参数即将下线，建议您使用 |
NextToken | String | 否 | caeba0bbb2be03f84eb48b699f0a**** | 分页查询凭证，用于标记分页的位置。
|
| MaxResults | Integer | 否 | 50 | 查询的数量，默认为 10，最大为100。 |
参数名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| RequestId | String | 2021062415303301022514515207C4**** | 请求ID。 |
TotalCount | Integer | 2 | 符合条件的共享带宽包总数。 说明 本参数即将下线，使用 |
PageNumber | Integer | 1 | 当前页码。 说明 本参数即将下线，建议您使用 |
PageSize | Integer | 10 | 当前分页的行数。 说明 本参数即将下线，建议您使用 |
| NextToken | String | caeba0bbb2be03f84eb48b699f0a**** | 本次API调用返回的查询凭证，标记分页的位置，用于下一次查询。返回为空表示没有下一页。 |
| BandwidthPackages | Array of struct | - | BandwidthPackages的详细信息列表。具体请见下表“BandwidthPackage结构”。 |
BandwidthPackage结构
参数名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| BandwidthPackageId | String | bwp-2zeo05qre24nhrqpy**** | 共享带宽包的ID。 |
| BandwidthPackageName | String | bwp-test | 共享带宽包的名称。 |
| Description | String | test | 共享带宽包的描述信息。 |
| ISP | String | BGP | 线路类型。 |
BillingType | string | 2 | 共享带宽包的计费方式。
|
| Bandwidth | Integer | 20 | 共享带宽包的带宽值，单位Mbps。 |
| Protocol | String | IPv4 | 共享带宽包的IP协议。 |
SecurityProtectionTypes | List | ["AntiDDoS_Enhanced"] | 共享带宽包的安全防护类型。
|
| ProjectName | String | Project_1 | 共享带宽包所属项目的名称。 |
| Tags | Array of struct | - | 共享带宽包的标签信息。具体请参见下表“Tags结构”。 |
| EipAddresses | Array of struct | - | 加入共享带宽包的公网IP信息列表。具体请见下表“EipAddresses结构”。 |
Status | String | Available | 共享带宽包的状态。
|
| BusinessStatus | String | Normal | 计费状态。 |
| CreationTime | String | 2022-02-20T01:37:38+08:00 | 创建共享带宽包的时间。 |
| UpdateTime | String | 2022-02-20T01:37:38+08:00 | 更新共享带宽包的时间。 |
| ExpiredTime | string | 2022-05-07 23:59:59 | 共享带宽包到期时间。 |
| OverdueTime | String | 2023-02-20T01:00:00+08:00 | 欠费关停时间。 |
| DeletedTime | String | 2023-02-22T01:00:00+08:00 | 欠费关停回收时间。 |
EipAddresses结构
参数名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| EipAddress | String | 180.XX.XX.54 | 公网IP的地址。 |
| AllocationId | String | eip-sdsdsd23233**** | 公网IP的ID。 |
Tags结构
参数名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Key | String | k1 | 标签键。 |
| Value | String | v1 | 标签值。 |
GET /?Action=DescribeBandwidthPackages&Version=2020-04-01&ISP=BGP HTTP/1.1 Host: open.volcengineapi.com Service: vpc Region: cn-beijing
{ "ResponseMetadata": { "RequestId": "2021062415303301022514515207C4****", "Action": "DescribeBandwidthPackages", "Version": "2020-04-01", "Service": "vpc", "Region": "cn-beijing" }, "Result":{ "RequestId": "2021062415303301022514515207C4****", "TotalCount":2, "PageNumber": 1, "PageSize": 20, "NextToken": "caeba0bbb2be03f84eb48b699f0a****", "BandwidthPackages":[ { "BandwidthPackageId":"bwp-2zeo05qre24nhrqpy****", "BandwidthPackageName":"bwp-01", "Description":"This is a bandwidthpackage", "ISP":"BGP", "BillingType": 2, "Bandwidth":20, "Protocol":"IPv4", "SecurityProtectionTypes":[ "AntiDDoS_Enhanced" ], "ProjectName":"Project_1", "Tags":[ { "Key":"k1", "Value":"v1" }, { "Key":"k2", "Value":"" } ], "EipAddresses":[ { "EipAddress":"180.XX.XX.54", "AllocationId":"eip-sdsdsd23233****" } ], "Status":"Available", "BusinessStatus": "", "CreationTime":"2022-02-20T01:37:38+08:00", "UpdateTime":"2022-02-20T01:37:38+08:00", "ExpiredTime":"2022-05-07 23:59:59", "OverdueTime":"", "DeletedTime":"" } ] } }
公共错误码，请参见 公共错误码 。
HttpCode | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | InvalidMaxResults.Malformed | The specified parameter MaxResults is malformed. | 查询数量不合法。 |
| 400 | InvalidNextToken.Malformed | The specified parameter NextToken is invalid. | 查询 NextToken 不合法。 |
| 400 | InvalidName.Malformed | The specified name is malformed. Ensure the maximum length of name is 128. | 指定的名称格式不合法。名称长度不能超过128个字符。 |
| 400 | InvalidName.Malformed | The specified name is malformed. | 指定的名称格式不合法。请修复名称格式后重试。 |
| 400 | InvalidTagFilter.Disorder | The specified index order of tag filter is malformed. | 指定标签过滤项的索引顺序参数格式不合法。 |
| 400 | InvalidTagFilterKey.Malformed | The specified parameter tag filter key is invalid. | 过滤标签键不合法。 |
| 400 | InvalidTagFilterValue.Malformed | The specified parameter tag filter value is invalid. | 过滤标签值不合法。 |
| 400 | LimitExceeded.TagFilterKey | You've reached the limit on the number of tag keys that you can filter. | 已达到单次可指定过滤标签键数量的上限。 |
| 400 | LimitExceeded.TagFilterValue | You've reached the limit on the number of tag values that you can filter. | 已达到单次可指定过滤标签值数量的上限。 |