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

DescribeTransitRouterVpnAttachments

最近更新时间：2024.01.10 10:46:58

首次发布时间：2023.03.07 09:56:38

我的收藏

调用DescribeTransitRouterVpnAttachments接口，查询满足指定条件的VPN类型网络实例连接。

请求参数

名称类型是否必选示例值描述
ActionString是DescribeTransitRouterVpnAttachments要执行的操作，取值为DescribeTransitRouterVpnAttachments。
VersionString是2020-04-01API版本信息，当前版本为2020-04-01。
TransitRouterIdString是tr-7qthudw0ll6jmc****中转路由器实例的ID。您可以调用DescribeTransitRouters接口获取中转路由器实例ID。
PageNumberInteger否1列表的页码，默认值为1。
PageSizeInteger否20分页查询时每页的行数，取值范围为1 ~ 100，默认值为20。

TransitRouterAttachmentIds.N

String

否

TransitRouterAttachmentIds.1=tr-attach-13n2l4c****&TransitRouterAttachmentIds.2=tr-attach-b1h2p6g****

网络实例连接的ID。调用DescribeTransitRouterVpnAttachments接口获取VPN类型网络实例连接的ID。

  • 参数 - N：表示网络实例连接的序号，取值范围为1～100，单次最多可查询100个。
  • 多个网络实例连接ID之间使用“&”分隔。
VpnConnectionIdString否vgc-3tex2x1cwd4c6c0v****IPsec连接的ID。您可以调用DescribeVpnConnections接口获取IPsec连接的ID。

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个标签值。
  • 未传入该参数时，表示查询指定标签键下所有标签值对应的标签所关联的VPN类型网络实例连接。
  • 该参数取值为空时，表示查询指定标签键下标签值为空的标签所关联的VPN类型网络实例连接。
  • 同一个标签键指定多个标签值时，表示查询各个标签值对应标签所关联VPN类型网络实例连接的集合。

说明

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

返回参数

名称
类型
示例值
描述
RequestIdString0ED8D006-F706-4D23-88ED-E11ED28D****请求ID。
PageSizeinteger20当前分页的行数。
PageNumberinteger1当前页码。
TotalCountInteger2符合条件的VPN类型网络实例连接总数。
TransitRouterAttachmentsArray of Struct-符合条件的VPN类型网络实例连接的详细信息。具体请参见下表“ TransitRouterAttachments ”。

TransitRouterAttachments

名称
类型
示例值
描述
TransitRouterIdStringtr-7qthudw0ll6jmc****中转路由器实例的ID。
TransitRouterAttachmentIdStringtr-attach-13n2l4c****网络实例连接的ID。
TransitRouterAttachmentNameStringtrattachment-01网络实例连接的名称。
DescriptionStringThis attachment is used for test.网络实例连接的描述信息。
VpnConnectionIdStringvgc-3tex2x1cwd4c6c0v****IPsec连接的ID。
ZoneIdStringcn-guangzhou-a网络实例连接所属可用区的ID。

Status

String

Available

网络实例连接的状态。

  • Creating: 创建中。
  • Deleting: 删除中。
  • Pending：配置中。
  • Available：可用。

AutoPublishRouteEnabled

Boolean

false

是否自动同步TR路由到网络实例路由表中。

  • true：是。
  • false：否。
CreationTimeString2021-04-09T08:36:47+08:00网络实例连接的创建时间。
UpdateTimeString2021-04-10T09:18:28+08:00网络实例连接的最近操作时间。
TagsArray of Struct-网络实例连接的标签信息。具体请参见下表“Tags”。

Tags

名称类型示例值描述
KeyStringk1网络实例连接标签的标签键。
ValueStringv1网络实例连接标签的标签值。

请求示例

GET /?Action=DescribeTransitRouterVpnAttachments&Version=2020-04-01&TransitRouterId=tr-7qthudw0ll6jmc**** HTTP/1.1
Host: open.volcengineapi.com
Service: transitrouter
Region: cn-guangzhou

返回示例

{
    "ResponseMetadata": {
        "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28D****",
        "Action": "DescribeTransitRouterVpnAttachments",
        "Version": "2020-04-01",
        "Service": "transitrouter",
        "Region": "cn-guangzhou"
    },
    "Result": {
        "PageNumber": 1,
        "PageSize": 20,
        "TotalCount": 1,
        "TransitRouterAttachments": [
            {
                "TransitRouterId": "tr-7qthudw0ll6jmc****",
                "TransitRouterAttachmentId": "tr-attach-13n2l4c****",
                "TransitRouterAttachmentName": "trattachment-01",
                "Description": "This attachment is used for test.",
                "VpnConnectionId": "vgc-3tex2x1cwd4c6c0v****",
                "ZoneId": "cn-guangzhou-a",
                "AutoPublishRouteEnabled": false,
                "CreationTime": "2021-04-09T08:36:47+08:00",
                "UpdateTime": "2021-04-10T09:18:28+08:00",
                "Status": "Available",
                "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.该请求传入了非法或不支持的参数。资源查询数目最大限制100。
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.已达到单次可指定过滤标签值数量的上限。