调用 DescribeTransitRouterBandwidthPackages 接口,查询满足指定条件的中转路由器带宽包。
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeTransitRouterBandwidthPackages | 要执行的操作,取值为DescribeTransitRouterBandwidthPackages。 |
Version | String | 是 | 2020-04-01 | API版本信息,当前版本为2020-04-01。 |
TransitRouterBandwidthPackageIds.N | String | 否 | TransitRouterBandwidthPackageIds.1=tr-bp-qw2u6ur8lhe2t****&TransitRouterBandwidthPackageIds.2=tr-bp-q6wr2ulu8e2th**** | 中转路由器带宽包的ID。
|
LocalGeographicRegionSetId | String | 否 | China | 中转路由器带宽包互通的本端地理区域ID。取值如下:
|
PeerGeographicRegionSetId | String | 否 | China | 中转路由器带宽包互通的对端地理区域ID。取值如下:
|
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 | 否 | TagFilters.1.Key=k1&TagFilters.2.Key=k2 | 中转路由器带宽包标签的标签键。
|
TagFilters.N.Values.N | String | 否 | TagFilters.1.Values.1=v1&TagFilters.1.Values.2=v2&TagFilters.2.Values.1=v3 | 中转路由器带宽包标签的标签值。
说明
|
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
PageSize | integer | 20 | 当前分页的行数。 |
PageNumber | integer | 1 | 当前页码。 |
TotalCount | Integer | 2 | 符合条件的中转路由器带宽包总数。 |
TransitRouterBandwidthPackages | Array of Struct | - | 符合条件的中转路由器带宽包的详细信息。具体请参见下表“ TransitRouterBandwidthPackages ”。 |
TransitRouterBandwidthPackages
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
TransitRouterBandwidthPackageId | String | tr-bp-qw2u6ur8lhe2t**** | 中转路由器带宽包ID。 |
AccountId | String | 210001**** | 中转路由器带宽包所属的账号ID。 |
TransitRouterBandwidthPackageName | String | trbp-01 | 中转路由器带宽包的名称。 |
Description | String | This package is used for test. | 中转路由器带宽包的描述信息。 |
LocalGeographicRegionSetId | String | China | 中转路由器带宽包互通的本端地理区域ID.
|
PeerGeographicRegionSetId | String | China | 中转路由器带宽包互通的对端地理区域ID。
|
Bandwidth | Integer | 2 | 中转路由器带宽包的带宽峰值,单位为Mbps。 |
RemainingBandwidth | Integer | 2 | 中转路由器带宽包剩余未分配的带宽,单位为Mbps。 |
Status | String | Available | 中转路由器带宽包的状态。
|
CreationTime | String | 2021-04-09T08:36:47+08:00 | 中转路由器带宽包的创建时间。 |
UpdateTime | String | 2021-04-10T09:18:28+08:00 | 中转路由器带宽包的最近操作时间。 |
BusinessStatus | String | Normal | 中转路由器带宽包的业务状态。取值如下:
|
BillingType | Integer | 1 | 中转路由器带宽包的计费方式。
|
DeletedTime | String | 2021-05-07 23:23:23 | 中转路由器带宽包的删除时间。 |
ExpiredTime | String | 2021-05-07 23:23:23 | 中转路由器带宽包的到期时间。 |
Allocations | Array of Struct | - | 带宽包关联的跨地域连接的详细信息。具体请参见下表“ Allocations ”。 |
ProjectName | String | default | 中转路由器带宽包所属项目的名称。 |
Tags | Array of Struct | - | 中转路由器带宽包的标签信息。具体请参见下表“Tags”。 |
Allocations
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
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。 |
Tags
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Key | String | k1 | 中转路由器带宽包标签的标签键。 |
Value | String | v1 | 中转路由器带宽包标签的标签值。 |
GET /?Action=DescribeTransitRouterBandwidthPackages&Version=2020-04-01&TransitRouterPeerAttachmentId=tr-attach-7qthudw0ll6jmc**** HTTP/1.1 Host: open.volcengineapi.com Service: transitrouter Region: cn-guangzhou
{ "ResponseMetadata": { "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28D****", "Action": "DescribeTransitRouterBandwidthPackages", "Version": "2020-04-01", "Service": "transitrouter", "Region": "cn-guangzhou" }, "Result": { "PageNumber": 1, "PageSize": 10, "TotalCount": 1, "TransitRouterBandwidthPackages": [ { "TransitRouterBandwidthPackageId": "tr-bp-4c2zaavbvh5x****", "AccountId": "210001****", "TransitRouterBandwidthPackageName": "trbp-test", "Description": "testdesc", "LocalGeographicRegionSetId": "China", "PeerGeographicRegionSetId": "China", "Bandwidth": 10, "RemainingBandwidth": 10, "Status": "Available", "CreationTime": "2018-04-18T15:02:37+08:00", "UpdateTime": "2018-04-18T15:02:37+08:00", "BusinessStatus": "Normal", "BillingType": 1, "ExpiredTime": "2021-05-07 23:59:59", "DeletedTime": "2021-05-22 00:00:00", "Allocations": [ { "TransitRouterPeerAttachmentId": "tr-attach-7qthudw0ll6jmc****", "AllocateTime": "2021-05-07 23:23:23", "LocalRegionId": "cn-beijing", "PeerRegionId": "cn-guangzhou" } ], "ProjectName": "default", "Tags": [ { "Key": "k1", "Value": "v1" } ] } ] } }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidPage.Malformed | The specified page is malformed. | 指定的分页参数不合法。 |
400 | LimitExceeded.ResourceIds | You've reached the limit of 100 resource IDs that can be specified in this request. | 已达到单次可查询的实例数量上限。 |
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 | LmitExceeded.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. | 已达到单次可指定过滤标签值数量的上限。 |