You need to enable JavaScript to run this app.
文档中心
中转路由器

中转路由器

复制全文
下载 pdf
中转路由器实例
DescribeTransitRouterAttachments - 查询TR连接列表
复制全文
下载 pdf
DescribeTransitRouterAttachments - 查询TR连接列表
调用DescribeTransitRouterAttachments接口,查询满足指定条件的TR连接,包括VPC、VPN、专线网关类型的网络实例连接和跨地域连接。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action String 必选 示例值:DescribeTransitRouterAttachments​
接口名称。当前 API 的名称为DescribeTransitRouterAttachments。​
​
Version String 必选 示例值:2020-04-01​
接口版本。当前 API 的版本为2020-04-01。​
​
TransitRouterId String 可选 示例值:tr-7qthudw0ll6jmc****​
中转路由器实例的ID。您可以调用DescribeTransitRouters接口获取中转路由器实例ID。​
​
PageNumber Integer 可选 示例值:1​
列表的页码,默认值为1。​
​
PageSize Integer 可选 示例值:20​
分页查询时每页的行数,取值范围为1 ~ 100,默认值为20。​
​
ResourceType String 可选 示例值:VPC​
网络实例的类型。取值如下:​
  • VPC:私有网络。​
  • VPN:VPN连接。​
  • DCGW:专线网关。​
  • TransitRouter:中转路由器。​
​
ResourceId String 可选 示例值:vpc-bp1aevy8sofi8mh1****​
网络实例的ID。​
  • 您可以调用DescribeVpcs接口获取VPC类型网络实例的ID。​
​
TransitRouterForwardPolicyTableId String 可选 示例值:tr-fpt-hy13n2l4c6c0v****​
跨地域连接关联的转发策略的ID。您可以调用DescribeTransitRouterForwardPolicyTables接口获取转发策略的ID。​
​
TransitRouterTrafficQosMarkingPolicyId String 可选 示例值:tr-tmp-hy13n2l4c6c0v****​
流标记策略的ID。您可以调用DescribeTransitRouterTrafficQosMarkingPolicies接口获取流标记策略的ID。​
​
TransitRouterTrafficQosQueuePolicyId String 可选 示例值:tr-tqp-hy13n2l4c6c0v****​
流队列策略的ID。您可以调用DescribeTransitRouterTrafficQosQueuePolicies接口获取流队列策略的ID。​
​
TransitRouterAttachmentIds.N String 可选 示例值:tr-attach-13n2l4c****​
网络实例连接的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​
符合条件的中转路由器实例总数。​
​
TransitRouterAttachments Object[] 示例值:--​
符合条件的中转路由器实例的详细信息。​
ResourceId String 示例值:vpc-bp1aevy8sofi8mh1****​
网络实例连接关联的网络实例ID。​
​
OverdueTime String 示例值:2021-05-07 23:23:23​
网络实例连接的欠费关停时间。​
​
DeletedTime String 示例值:2021-05-07 23:23:23​
网络实例连接的删除时间。​
​
CreationTime String 示例值:2021-04-09T08:36:47+08:00​
网络实例连接的创建时间。​
​
Description String 示例值:This attachment is used for test.​
网络实例连接的描述信息。​
​
TransitRouterAttachmentId String 示例值:tr-attach-13n2l4c****​
网络实例连接的ID。​
​
TransitRouterId String 示例值:tr-3tehy13n2l4c6c0v****​
中转路由器实例的ID。​
​
TransitRouterAttachmentName String 示例值:trattachment-01​
网络实例连接的名称。​
​
TransitRouterRouteTableId String 示例值:tr-rtb-hy13n2l4c6c0v****​
网络实例连接关联转发的路由表ID。​
​
UpdateTime String 示例值:2021-04-10T09:18:28+08:00​
网络实例连接的最近操作时间。​
​
AccountId String 示例值:200001****​
网络实例连接所属的账号ID。​
​
Tags Object[]​
网络实例连接的标签信息。​
Key String 示例值:k1​
标签的标签键。​
​
Value String 示例值:v1​
标签的标签值。​
​
​
TransitRouterForwardPolicyTableId String 示例值:tr-fpt-hy13n2l4c6c0v****​
跨地域连接关联的转发策略的ID。​
​
TransitRouterTrafficQosMarkingPolicyId String 示例值:tr-tmp-hy13n2l4c6c0v****​
网络实例连接关联的流标记策略的ID。​
​
TransitRouterTrafficQosQueuePolicyId String 示例值:tr-tqp-hy13n2l4c6c0v****​
网络实例连接关联的流队列策略的ID。​
​
ResourceType String 示例值:VPC​
网络实例连接关联的网络实例类型。​
  • VPC:私有网络。​
  • VPN:VPN连接。​
  • DirectConnectGateway:专线网关。​
  • TransitRouter:中转路由器。​
​
Status String 示例值:Available​
网络实例连接的状态。​
  • Creating: 创建中。​
  • Deleting: 删除中。​
  • Pending:配置中。​
  • Available:可用。​
​
Ipv6Enabled Boolean 示例值:true​
是否启用IPv6。​
  • true:是。​
  • false:否。​
​
AutoPublishRouteEnabled Boolean 示例值:false​
是否自动同步TR路由到网络实例路由表中。​
  • true:是。​
  • false:否。​
​
BusinessStatus String 示例值:Normal​
网络实例连接的业务状态。​
  • Normal:正常。​
  • FinancialLocked:已冻结。​
​
BillingAccountId String 示例值:2000****59​
中转路由器同地域连接的计费账号 ID。跨地域连接不返回该参数。​
  • 网络实例连接返回其计费账号 ID。​
  • 同地域Peering连接返回本端TR实例所属账号ID。​
​
​
​
​
请求示例​
​
GET /?Action=DescribeTransitRouterAttachments&Version=2020-04-01 HTTP/1.1​
Host: transitrouter.cn-beijing.volcengineapi.com​
X-Date: 20250804T033345Z​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250804/cn-beijing/transitrouter/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "20230604110420****100232280022D31",​
"Action": "DescribeTransitRouterAttachments",​
"Version": "2020-04-01",​
"Service": "transitrouter",​
"Region": "cn-beijing"​
},​
"Result": {​
"PageNumber": 1,​
"PageSize": 20,​
"TotalCount": 2,​
"TransitRouterAttachments": [​
{​
"Tags": [​
{​
"Key": "k1",​
"Value": "v1"​
}​
],​
"Status": "Available",​
"AccountId": "200001****",​
"ResourceId": "vpc-bp1aevy8sofi8mh1****",​
"UpdateTime": "2021-04-10T09:18:28+08:00",​
"DeletedTime": "2021-05-07 23:23:23",​
"Description": "This attachment is used for test.",​
"Ipv6Enabled": true,​
"OverdueTime": "2021-05-07 23:23:23",​
"CreationTime": "2021-04-09T08:36:47+08:00",​
"ResourceType": "VPC",​
"BusinessStatus": "Normal",​
"TransitRouterId": "tr-3tehy13n2l4c6c0v****",​
"BillingAccountId": "2000****59",​
"AutoPublishRouteEnabled": true,​
"TransitRouterAttachmentId": "tr-attach-13n2l4c****",​
"TransitRouterRouteTableId": "tr-rtb-hy13n2l4c6c0v****",​
"TransitRouterAttachmentName": "trattachment-01",​
"TransitRouterForwardPolicyTableId": "tr-fpt-hy13n2l4c6c0v****",​
"TransitRouterTrafficQosQueuePolicyId": "tr-tqp-hy13n2l4c6c0v****",​
"TransitRouterTrafficQosMarkingPolicyId": "tr-tmp-hy13n2l4c6c0v****"​
}​
]​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
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.​
已达到单次可指定过滤标签值数量的上限。​
​
​
最近更新时间:2026.02.11 10:42:42
这个页面对您有帮助吗?
有用
有用
无用
无用