You need to enable JavaScript to run this app.
导航
中转路由器
  • 文档首页
    • /
  • 中转路由器

DescribeTransitRouterBandwidthPackages

最近更新时间：2024.01.12 11:13:05

首次发布时间：2023.09.12 10:21:32

我的收藏

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

请求参数

名称类型是否必选示例值描述
ActionString是DescribeTransitRouterBandwidthPackages要执行的操作，取值为DescribeTransitRouterBandwidthPackages。
VersionString是2020-04-01API版本信息，当前版本为2020-04-01。

TransitRouterBandwidthPackageIds.N

String

否

tr-bp-qw2u6ur8lhe2t****

中转路由器带宽包的ID。您可以调用本接口获取中转路由器带宽包的ID。

  • 参数 - N：表示中转路由器带宽包的序号，取值范围为1～100，单次最多可查询100个。
  • 多个中转路由器带宽包ID之间使用“&”分隔。

LocalGeographicRegionSetId

String

否

China

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

  • China：中国大陆。

PeerGeographicRegionSetId

String

否

China

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

  • China：中国大陆。
TransitRouterPeerAttachmentIdString否tr-attach-12w7hruhlhlrd****跨地域连接的ID。
TransitRouterBandwidthPackageNameString否trbp-test中转路由器带宽包的名称。
PageNumberInteger否1列表的页码，默认值为1。
PageSizeInteger否20分页查询时每页的行数，取值范围为1 ~ 100**，** 默认值为20。
ProjectNameString否default中转路由器带宽包所属项目的名称。

TagFilters.N.Key

String

否

TagFilters.1.Key=k1&TagFilters.2.Key=k2

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

  • 参数 - N：表示标签键的序号，单次调用数量上限10个。多个标签键之间使用&分隔。
  • 指定多个标签键时，表示查询同时包含所有指定标签键的中转路由器带宽包。

TagFilters.N.Values.M

String

否

TagFilters.1.Values.1=v1&TagFilters.1.Values.2=v2&TagFilters.2.Values.1=v3

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

  • 参数 - M：表示标签值的序号，单次调用每个标签键最多可指定3个标签值。
  • 未传入该参数时，表示查询指定标签键下所有标签值对应的标签所关联的中转路由器带宽包。
  • 该参数取值为空时，表示查询指定标签键下标签值为空的标签所关联的中转路由器带宽包。
  • 同一个标签键指定多个标签值时，表示查询各个标签值对应标签所关联中转路由器带宽包的集合。

说明

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

返回参数

名称类型示例值描述
RequestIdString0ED8D006-F706-4D23-88ED-E11ED28D****请求ID。
PageSizeinteger20当前分页的行数。
PageNumberinteger1当前页码。
TotalCountInteger2符合条件的中转路由器带宽包总数。
TransitRouterBandwidthPackagesArray of Struct-符合条件的中转路由器带宽包的详细信息。具体请参见下表“ TransitRouterBandwidthPackages ”。

TransitRouterBandwidthPackages

名称类型示例值描述
TransitRouterBandwidthPackageIdStringtr-bp-qw2u6ur8lhe2t****中转路由器带宽包ID。
TransitRouterBandwidthPackageNameStringtrbp-01中转路由器带宽包的名称。
DescriptionStringThis package is used for test.中转路由器带宽包的描述信息。

LocalGeographicRegionSetId

String

China

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

  • China：中国大陆。

PeerGeographicRegionSetId

String

China

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

  • China：中国大陆。
BandwidthInteger2中转路由器带宽包的带宽峰值，单位为Mbps。
RemainingBandwidthInteger2中转路由器带宽包剩余未分配的带宽，单位为Mbps。

Status

String

Available

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

  • Creating: 创建中。
  • Deleting: 删除中。
  • Pending：配置中。
  • Available：可用。
CreationTimeString2021-04-09T08:36:47+08:00中转路由器带宽包的创建时间。
UpdateTimeString2021-04-10T09:18:28+08:00中转路由器带宽包的最近操作时间。

BusinessStatus

String

Normal

中转路由器带宽包的业务状态。取值如下：

  • Normal：正常。
  • FinancialLocked：已冻结。

BillingType

Integer

1

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

  • 1：包年包月。
DeletedTimeString2021-05-07 23:23:23中转路由器带宽包的删除时间。
ExpiredTimeString2021-05-07 23:23:23中转路由器带宽包的到期时间。
AllocationsArray of Struct-带宽包关联的跨地域连接的详细信息。具体请参见下表“ Allocations ”。
ProjectNameStringdefault中转路由器带宽包所属项目的名称。
TagsArray of Struct-中转路由器带宽包的标签信息。具体请参见下表“Tags”。

Allocations

名称类型示例值描述
TransitRouterPeerAttachmentIdStringtr-attach-12w7hruhlhlrd****跨地域连接的ID。
AllocateTimeString2021-05-07 23:23:23带宽包关联至该跨地域连接的时间。
LocalRegionIdStringcn-beijing跨地域连接本端中转路由器实例所属地域的ID。
PeerRegionIdStringcn-guangzhou跨地域连接对端中转路由器实例所属地域的ID。
BandwidthInteger2跨地域连接的带宽峰值，单位为Mbps。

Tags

名称类型示例值描述
KeyStringk1中转路由器带宽包标签的标签键。
ValueStringv1中转路由器带宽包标签的标签值。

请求示例

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****",
                "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错误码错误信息描述
400InvalidPage.MalformedThe specified page is malformed.指定的分页参数不合法。
400LimitExceeded.ResourceIdsYou've reached the limit of 100 resource IDs that can be specified in this request.已达到单次可查询的实例数量上限。
400InvalidTagFilter.DisorderThe specified index order of tag filter is malformed.指定标签过滤项的索引顺序参数格式不合法。
400InvalidTagFilterKey.MalformedThe specified parameter tag filter key is invalid.过滤标签键不合法。
400InvalidTagFilterValue.MalformedThe specified parameter tag filter value is invalid.过滤标签值不合法。
400LmitExceeded.TagFilterKeyYou've reached the limit on the number of tag keys that you can filter.已达到单次可指定过滤标签键数量的上限。
400LimitExceeded.TagFilterValueYou've reached the limit on the number of tag values that you can filter.已达到单次可指定过滤标签值数量的上限。