调用 DescribeTransitRouterBandwidthPackages 接口，查询满足指定条件的中转路由器带宽包。

调试

API Explorer

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

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action String 必选示例值：DescribeTransitRouterBandwidthPackages

接口名称。当前 API 的名称为DescribeTransitRouterBandwidthPackages。

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

接口版本。当前 API 的版本为2020-04-01。

TransitRouterBandwidthPackageIds.N String 必选示例值：tr-bp-qw2u6ur8lhe2t****

中转路由器带宽包的ID。

N：表示中转路由器带宽包的序号，取值范围为1～100。

多个中转路由器带宽包ID之间使用“&”分隔。

LocalGeographicRegionSetId String 必选示例值：China

中转路由器带宽包互通的本端地理区域ID。取值如下：

China：中国大陆。

Asia：亚太。

PeerGeographicRegionSetId String 必选示例值：China

中转路由器带宽包互通的对端地理区域ID。取值如下：

China：中国大陆。

Asia：亚太。

TransitRouterPeerAttachmentId String 必选示例值：tr-attach-12w7hruhlhlrd****

跨地域连接的ID。

TransitRouterBandwidthPackageName String 必选示例值：trbp-test

中转路由器带宽包的名称。

PageNumber Integer 必选示例值：1

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

PageSize Integer 必选示例值：20

分页查询时每页的行数，取值范围为1 ~ 100，默认值为20。

ProjectName String 必选示例值：default

中转路由器带宽包所属项目的名称。

TagFilters.N.Key String 必选示例值：k1

中转路由器带宽包标签的标签键。

N：表示标签键的序号，取值范围1~10。多个标签键之间使用&分隔。

指定多个标签键时，表示查询同时包含所有指定标签键的中转路由器带宽包。

TagFilters.N.Values.N String 必选示例值：v1

中转路由器带宽包标签的标签值。

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

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

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

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

该参数传入空值时，表示查询指定标签键下标签值为空的资源。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

PageNumber Integer 示例值：1

当前页码。

PageSize Integer 示例值：20

当前分页的行数。

TotalCount Integer 示例值：2

符合条件的中转路由器带宽包总数。

TransitRouterBandwidthPackages Object[] 示例值：-

符合条件的中转路由器带宽包的详细信息。

LineOperator String 示例值：ChinaUnicom

跨境带宽包线路运营商

Tags Object[] 示例值：-

中转路由器带宽包的标签信息。

Key String 示例值：k1

标签的标签键。

Value String 示例值：v1

标签的标签值。

ProjectName String 示例值：default

中转路由器带宽包所属项目的名称。

TransitRouterBandwidthPackageId String 示例值：tr-bp-qw2u6ur8lhe2t****

中转路由器带宽包ID。

TransitRouterBandwidthPackageName String 示例值：trbp-01

中转路由器带宽包的名称。

Description String 示例值：This package is used for test.

中转路由器带宽包的描述信息。

LocalGeographicRegionSetId String 示例值：China

中转路由器带宽包互通的本端地理区域ID.

China：中国大陆。

Asia：亚太。

PeerGeographicRegionSetId String 示例值：China

中转路由器带宽包互通的对端地理区域ID。

China：中国大陆。

Asia：亚太。

Bandwidth Integer 示例值：2

中转路由器带宽包的带宽峰值，单位为Mbps。

RemainingBandwidth Integer 示例值：2

中转路由器带宽包剩余未分配的带宽，单位为Mbps。

Status String 示例值：Available

中转路由器带宽包的状态。

Creating: 创建中。

Deleting: 删除中。

Pending：配置中。

Available：可用。

CreationTime String 示例值：2021-04-09T08:36:47+08:00

中转路由器带宽包的创建时间。

UpdateTime String 示例值：2021-04-10T09:18:28+08:00

中转路由器带宽包的最近操作时间。

BusinessStatus String 示例值：Normal

中转路由器带宽包的业务状态。

Normal：正常。

FinancialLocked：已冻结。

BillingType Integer 示例值：1

中转路由器带宽包的计费方式。

1：包年包月。

DeletedTime String 示例值：2021-05-07 23:23:23

中转路由器带宽包的删除时间。

ExpiredTime String 示例值：2021-05-07 23:23:23

中转路由器带宽包的到期时间。

Allocations Object[] 示例值：-

带宽包关联的跨地域连接的详细信息。

TransitRouterPeerAttachmentId String 示例值：tr-attach-12w7hruhlhlrd****

跨地域连接的ID。

AllocateTime String 示例值：2021-05-07 23:23:23

带宽包关联至该跨地域连接的时间。

LocalRegionId String 示例值：cn-beijing

跨地域连接本端中转路由器实例所属地域的ID。

PeerRegionId String 示例值：cn-guangzhou

跨地域连接对端中转路由器实例所属地域的ID。

Bandwidth Integer 示例值：2

跨地域连接的带宽峰值，单位为Mbps。

AccountId String 示例值：200000****

带宽包所属的账号ID。

ExpectedExpireShutdownTime String 示例值：2024-06-05T23:59:59+08:00

中转路由器带宽包的到期关停时间。

请求示例

返回示例

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
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.ResourceIds	You've reached the limit of 100 resource IDs that can be specified in this request.	已达到单次可查询的实例数量上限。
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.	已达到单次可指定过滤标签值数量的上限。