调用DescribeTransitRouters接口，查询满足指定条件的中转路由器实例。

调试

API Explorer

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

去调试

请求参数

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

Action String 必选示例值：DescribeTransitRouters

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

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

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

TransitRouterName String 可选示例值：transitrouter-01

中转路由器实例的名称。

PageNumber Integer 可选示例值：1

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

PageSize Integer 可选示例值：20

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

ProjectName String 可选示例值：default

中转路由器实例所属项目的名称。

TransitRouterIds.N String 可选示例值：tr-7qthudw0ll6jmc****

中转路由器实例的ID。您可以调用DescribeTransitRouters接口获取中转路由器实例ID。

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

多个中转路由器实例ID之间使用“&”分隔。

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

中转路由器实例标签的标签键。

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

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

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

中转路由器实例标签的标签值。

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

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

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

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

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

返回参数

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

PageSize Integer 示例值：20

当前分页的行数。

PageNumber Integer 示例值：1

当前页码。

TotalCount Integer 示例值：2

符合条件的中转路由器实例总数。

TransitRouters Object[] 示例值：--

符合条件的中转路由器实例的详细信息。

AccountId String 示例值：200000****

中转路由器实例所属的账号ID。

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

中转路由器实例的创建时间。

DeletedTime String 示例值：2021-05-22 00:00:00

中转路由器实例的删除时间。

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

中转路由器实例的描述信息。

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

中转路由器实例的欠费关停时间。

TransitRouterName String 示例值：transitrouter-01

中转路由器实例的名称。

TransitRouterId String 示例值：tr-3tehy13n2l4c6c0v****

中转路由器实例的ID。

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

中转路由器实例的最近操作时间。

BusinessStatus String 示例值：Normal

中转路由器实例的业务状态。

Normal：正常。

FinancialLocked：已冻结。

Status String 示例值：Available

中转路由器实例的状态。

Creating: 创建中。

Deleting: 删除中。

Pending：配置中。

Available：可用。

GrantStatus String 示例值：Initial

共享规则的状态。

Accepted：已接受。

Initial：待接受。

Asn Integer 示例值：64512

中转路由器的ASN号。

MulticastEnabled Boolean 示例值：false

是否开启组播功能。

ProjectName String 示例值：default

中转路由器实例所属项目的名称。

Tags Object[] 示例值：--

中转路由器实例的标签信息。

Key String 示例值：k1

标签的标签键。

Value String 示例值：v1

标签的标签值。

GrantSourceType String 示例值：rs

中转路由器实例的共享方式。

rs：通过平台资源共享功能共享。

tr：通过中转路由器实例共享功能共享。

BillingOwnerType String 示例值：ResourceOwner

网络实例连接的付费主体。

TransitRouterOwner：表示网络实例连接产生的费用由中转路由器实例所属的账号承担。

ResourceOwner：表示网络实例连接产生的费用由网络实例所属的账号承担。

请求示例

返回示例

错误码

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

状态码	错误码	错误信息	说明
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.	该请求传入了非法或不支持的参数。资源查询数目最大限制100。
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.	已达到单次可指定过滤标签值数量的上限。