DescribeTransitRouterVpnAttachments--中转路由器-火山引擎

文档中心

立即注册

导航

DescribeTransitRouterVpnAttachments

最近更新时间：2024.09.10 10:14:48首次发布时间：2023.03.07 09:56:38

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

调试

API Explorer

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

去调试

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DescribeTransitRouterVpnAttachments	要执行的操作，取值为DescribeTransitRouterVpnAttachments。
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。
TransitRouterAttachmentIds.N	String	否	TransitRouterAttachmentIds.1=tr-attach-13n2l4c**&TransitRouterAttachmentIds.2=tr-attach-b1h2p6g**	网络实例连接的ID。 N：表示网络实例连接的序号，取值范围为1～100。多个网络实例连接ID之间使用&分隔。
VpnConnectionId	String	否	vgc-3tex2x1cwd4c6c0v****	IPsec连接的ID。您可以调用DescribeVpnConnections接口获取IPsec连接的ID。
TagFilters.N.Key	String	否	TagFilters.1.Key=k1&TagFilters.2.Key=k2	网络实例连接标签的标签键。 N：表示标签键的序号，取值范围 1～10。多个标签键之间使用&分隔。指定多个标签键时，表示查询同时包含所有指定标签键的网络实例连接。
TagFilters.N.Values.N	String	否	TagFilters.1.Values.1=v1&TagFilters.1.Values.2=v2&TagFilters.2.Values.1=v3	网络实例连接标签的标签值。第一个N：表示标签键的序号，取值范围 1～10。第二个N：表示标签值的序号，取值范围 1～3。同一标签键多个标签值之间的关系为逻辑“或(OR)”，即查询同一标签键下添加其中一个标签值的资源。多个标签值之间使用&分隔。说明如果传入该参数，则必须先传入`TagFilters.N.Key`。该参数传入空值时，表示查询指定标签键下标签值为空的资源。

返回参数

名称	类型	示例值	描述
PageSize	integer	20	当前分页的行数。
PageNumber	integer	1	当前页码。
TotalCount	Integer	2	符合条件的VPN类型网络实例连接总数。
TransitRouterAttachments	Array of Struct	-	符合条件的VPN类型网络实例连接的详细信息。具体请参见下表“ TransitRouterAttachments ”。

TransitRouterAttachments

名称	类型	示例值	描述
TransitRouterId	String	tr-7qthudw0ll6jmc****	中转路由器实例的ID。
TransitRouterAttachmentId	String	tr-attach-13n2l4c****	网络实例连接的ID。
TransitRouterAttachmentName	String	trattachment-01	网络实例连接的名称。
Description	String	This attachment is used for test.	网络实例连接的描述信息。
VpnConnectionId	String	vgc-3tex2x1cwd4c6c0v****	IPsec连接的ID。
ZoneId	String	cn-guangzhou-a	网络实例连接所属可用区的ID。
Status	String	Available	网络实例连接的状态。 Creating: 创建中。 Deleting: 删除中。 Pending：配置中。 Available：可用。
AutoPublishRouteEnabled	Boolean	false	是否自动同步TR路由到网络实例路由表中。 true：是。 false：否。
CreationTime	String	2021-04-09T08:36:47+08:00	网络实例连接的创建时间。
UpdateTime	String	2021-04-10T09:18:28+08:00	网络实例连接的最近操作时间。
Tags	Array of Struct	-	网络实例连接的标签信息。具体请参见下表“Tags”。

Tags

名称	类型	示例值	描述
Key	String	k1	网络实例连接标签的标签键。
Value	String	v1	网络实例连接标签的标签值。

请求示例

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