调用 DescribeBandwidthPackages 接口，查询满足指定条件的共享带宽包。

使用说明

传入多个请求参数，按照传入的参数进行查询，返回符合所有条件的共享带宽包，若没有符合条件的共享带宽包，则返回空值。

若请求参数非必选参数均未传入，则按照当前登录账号查询，返回当前账号下的所有共享带宽包。

使用标签过滤共享带宽包实例时，最多可查询指定标签关联的1000个共享带宽包实例。如果指定标签关联的共享带宽包实例超过1000个，则请您使用 ListTagsForResources 接口查询。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

Action String 必选示例值：DescribeBandwidthPackages

要执行的操作，取值：DescribeBandwidthPackages。

Version String 必选示例值：2020-04-01

API的版本信息，当前版本为 2020-04-01。

BandwidthPackageIds.N String 可选示例值：BandwidthPackageIds.1=bwp-2zeo05qre24nhrqpy**** &BandwidthPackageIds.2=bwp-1231283asdasd2312***

要查询的共享带宽包实例ID。

参数 - N：表示共享带宽包ID的序号。

多个共享带宽包的 ID之间用&分隔。

BandwidthPackageName String 可选示例值：bwp-01

共享带宽包的名称。

ISP String 可选示例值：BGP

共享带宽包的线路类型。取值如下：

BGP：BGP（多线）。

若您的账号已申请并开通了静态单线权限，则可传入如下取值：

ChinaMobile：中国移动静态单线。

ChinaTelecom：中国电信静态单线。

ChinaUnicom：中国联通静态单线。

若您的账号已申请并开通了BGP单线权限，则可传入SingleLine_BGP。

若您的账号已申请并开通了精品BGP权限，则可传入Premium_BGP。

若您的账号已申请并开通了融合BGP权限，则可传入Fusion_BGP。

若您的账号已申请并开通了惠选型静态单线权限，则可传入如下取值：

ChinaMobile_Value：中国移动惠选型静态单线。

ChinaUnicom_Value：中国联通惠选型静态单线。

ChinaTelecom_Value：中国电信惠选型静态单线。

Protocol String 可选示例值：IPv4

共享带宽包的IP协议，取值如下：

Dual-stack：双栈协议类型。

IPv4：IPv4协议类型协议。

仅BillingType传2或4时，本参数支持传入Dual-stack。

SecurityProtectionEnabled Boolean 可选示例值：true

共享带宽包的安全防护类型。

true：增强防护。

false：基础防护。

ProjectName String 可选示例值：Project_1

共享带宽包所属项目的名称。

TagFilters.N.Key String 可选示例值：TagFilters.1.Key=k1&TagFilters.2.Key=k2&TagFilters.3.Key=k3

标签的标签键。

参数 - N：表示标签键的序号，取值范围：1～10。

多个标签键之间用&分隔。多个标签键之间的关系为逻辑“与（AND）”，即查询同时添加多个标签键的共享带宽包。

不允许重复。

PageNumber Integer 可选示例值：1

列表的页码。默认值为1。

说明

本参数即将下线，建议您使用NextToken和MaxResults进行分页查询。

PageSize Integer 可选示例值：20

分页查询时每页的行数。最大值为100，默认值为20。

说明

本参数即将下线，建议您使用NextToken和MaxResults进行分页查询。

NextToken String 可选示例值：caeba0bbb2be03f84eb48b699f0a****

分页查询凭证，用于标记分页的位置。

不填则从头开始查询。

传入之前调用本API返回的NextToken，则从该次API调用标记分页的位置往后开始查询。

MaxResults Integer 可选示例值：50

查询的数量，默认为 10，最大为100。

TagFilters.N.Values.N String 可选示例值：TagFilters.1.Values.1=v1&TagFilters.1.Values.2=v2&TagFilters.3.Values.1=v1

标签的标签值。

第一个N：表示标签键的序号，取值范围：1～10。

第二个N：表示标签值的序号，取值范围：1～3。同一标签键多个标签值之间的关系为逻辑“或(OR)”，即查询同一标签键下添加其中一个标签值的共享带宽包。

多个标签值之间用&分隔。

说明

若传入该参数，则必须先传入TagFilters.N.Key。

传入空字符串时，表示查询标签值为空的共享带宽包。

返回参数

RequestId String 示例值：2021062415303301022514515207C4****

请求ID。

TotalCount Integer 示例值：2

符合条件的共享带宽包总数。

说明

本参数即将下线，使用NextToken和MaxResults分页查询时，此参数无意义。

PageNumber Integer 示例值：1

当前页码。

说明

本参数即将下线，建议您使用NextToken和MaxResults进行分页查询。

PageSize Integer 示例值：10

当前分页的行数。

说明

本参数即将下线，建议您使用NextToken和MaxResults进行分页查询。

NextToken String 示例值：caeba0bbb2be03f84eb48b699f0a****

本次API调用返回的查询凭证，标记分页的位置，用于下一次查询。返回为空表示没有下一页。

BandwidthPackages Object[] 示例值：-

BandwidthPackages的详细信息列表。

BandwidthPackageId String 示例值：bwp-2zeo05qre24nhrqpy****

共享带宽包的ID。

BandwidthPackageName String 示例值：bwp-test

共享带宽包的名称。

Description String 示例值：test

共享带宽包的描述信息。

ISP String 示例值：BGP

线路类型。

BillingType Integer 示例值：2

共享带宽包的计费方式。

1：包年包月。

2 : 按带宽上限计费。

3：按主流量计费。

4 : 按传统95计费。

Bandwidth Integer 示例值：20

共享带宽包的带宽值，单位Mbps。

Protocol String 示例值：IPv4

共享带宽包的IP协议。

Ratio Integer 示例值：20

95计费保底比例，单位%。

仅95计费共享带宽包实例返回此参数。

SecurityProtectionTypes String[] 示例值：["AntiDDoS_Enhanced"]

共享带宽包的安全防护类型。

AntiDDoS_Enhanced：增强防护。

空值：基础防护。

ProjectName String 示例值：Project_1

共享带宽包所属项目的名称。

Tags Object[] 示例值：-

共享带宽包的标签信息。

Key String 示例值：k1

标签键。

Value String 示例值：v1

标签值。

EipAddresses Object[] 示例值：-

加入共享带宽包的公网IP信息列表。

Protocol String 示例值：IPv4

IP的协议类型。

IPv4：IPv4 协议的IP地址。

IPv6：IPv6 协议的IP地址。

EipAddress String 示例值：12.35.67.89

公网IP的地址。

AllocationId String 示例值：eip-2zeerraiwb7ujxscd

公网IP的ID。

Status String 示例值：Available

共享带宽包的状态。

Creating：创建中。

Available：可用。

Deleting：删除中。

BusinessStatus String 示例值：Normal

计费状态。

Normal: 正常。

FinancialLocked: 被锁定。

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

欠费关停回收时间。

请求示例

返回示例

错误码

公共错误码请参见公共错误码。

状态码	错误码	错误信息	说明
400	DryRunOperation	Exception raised to indicate a successfully authorized action when the DryRun flag is set to true.	该请求设置为DryRun操作，操作授权已获得许可，但未被实际执行。
400	InvalidMaxResults.Malformed	The specified parameter MaxResults is malformed.	查询数量不合法。
400	InvalidNextToken.Malformed	The specified parameter NextToken is invalid.	查询 NextToken 不合法。
400	InvalidPage.Malformed	The specified page 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.	已达到单次可指定过滤标签值数量的上限。