调用ListTransitRouterVpnAttachments接口查询VPN连接的信息。

使用说明

在您调用ListTransitRouterVpnAttachments接口的过程中:

  • 如果仅指定了CenIdRegionId参数的值,则系统自动查询当前地域下所有VPN连接的信息。
  • 如果指定了CenIdRegionIdTransitRouterAttachmentId的值,则系统仅查询指定VPN连接的信息。
  • 如果您指定了CenIdRegionId参数的值,则无需指定TransitRouterId参数的值。如果指定了TransitRouterId参数的值,则无需指定CenIdRegionId参数的值。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String ListTransitRouterVpnAttachments

系统规定参数。取值:ListTransitRouterVpnAttachments

CenId String cen-rsgxs8ng2awen2****

云企业网实例ID。

RegionId String ap-southeast-2

转发路由器实例所属的地域ID。

您可以通过调用DescribeChildInstanceRegions接口获取地域ID。

TransitRouterAttachmentId String tr-attach-a6p8voaodog5c0****

VPN连接ID。

TransitRouterId String tr-p0wm740vjnbaprv0m****

转发路由器实例ID。

MaxResults Integer 20

分页查询时每页显示的条目数。默认值:20

NextToken String FFmyTO70tTpLG6I3FmYAXGKPd****

是否拥有下一次查询的令牌(Token)。取值:

  • 第一次查询和没有下一次查询时,均无需填写。
  • 如果有下一次查询,取值为上一次API调用返回的NextToken值。

返回数据

名称 类型 示例值 描述
NextToken String FFmyTO70tTpLG6I3FmYAXGKPd****

是否拥有下一次查询的令牌(Token)。取值:

  • 如果NextToken为空表示没有下一次查询。
  • 如果NextToken有返回值,该取值表示下一次查询开始的令牌。
RequestId String 3D5530D2-3BBB-524E-8E98-59AB06A250E4

请求ID。

TotalCount Integer 1

列表条目数。

MaxResults Integer 20

分页查询时每页显示的条目数。

TransitRouterAttachments Array of TransitRouterAttachment

VPN连接信息列表。

CreationTime String 2022-07-08T08:45Z

创建VPN连接的时间。

时间按照ISO8601标准表示,并使用UTC时间。格式为:YYYY-MM-DDThh:mmZ。

Status String Attached

VPN连接的状态。

  • Attached:已加载。
  • Attaching:加载中。
  • Detaching:卸载中。
  • Detached:已卸载。
TransitRouterAttachmentId String tr-attach-a6p8voaodog5c0****

VPN连接ID。

TransitRouterId String tr-p0wm740vjnbaprv0m****

转发路由器实例ID。

ResourceType String VPN

VPN连接所属的资源类型。

仅取值:VPN,表示转发路由器连接了IPsec连接。

VpnOwnerId Long 1210123456123456

IPsec连接所属的阿里云账号(主账号)ID。

VpnId String vco-p0wtu1xgd0l7fjo7k****

IPsec连接ID。

TransitRouterAttachmentDescription String desctest

VPN连接的描述信息。

VpnRegionId String ap-southeast-2

IPsec连接所属的地域ID。

您可以通过调用DescribeRegions接口获取地域ID。

AutoPublishRouteEnabled Boolean true

是否允许转发路由器实例自动向IPsec连接发布路由条目。取值:

  • true:允许。
  • false:不允许。
TransitRouterAttachmentName String nametest

VPN连接的名称。

Zones Array of ZoneMapping

部署VPN连接的可用区列表。

ZoneId String ap-southeast-2a

可用区ID。

您可以通过调用DescribeZones接口查询可用区ID对应的可用区的信息。

示例

请求示例

http(s)://[Endpoint]/?Action=ListTransitRouterVpnAttachments
&CenId=cen-rsgxs8ng2awen2****
&RegionId=ap-southeast-2
&TransitRouterAttachmentId=tr-attach-a6p8voaodog5c0****
&TransitRouterId=tr-p0wm740vjnbaprv0m****
&MaxResults=20
&NextToken=FFmyTO70tTpLG6I3FmYAXGKPd****
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ListTransitRouterVpnAttachmentsResponse>
    <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>
    <RequestId>3D5530D2-3BBB-524E-8E98-59AB06A250E4</RequestId>
    <TotalCount>1</TotalCount>
    <MaxResults>20</MaxResults>
    <TransitRouterAttachments>
        <CreationTime>2022-07-08T08:45Z</CreationTime>
        <Status>Attached</Status>
        <TransitRouterAttachmentId>tr-attach-a6p8voaodog5c0****</TransitRouterAttachmentId>
        <TransitRouterId>tr-p0wm740vjnbaprv0m****</TransitRouterId>
        <VpnOwnerId>1210123456123456</VpnOwnerId>
        <VpnId>vco-p0wtu1xgd0l7fjo7k****</VpnId>
        <TransitRouterAttachmentDescription>desctest</TransitRouterAttachmentDescription>
        <VpnRegionId>ap-southeast-2</VpnRegionId>
        <AutoPublishRouteEnabled>true</AutoPublishRouteEnabled>
        <TransitRouterAttachmentName>nametest</TransitRouterAttachmentName>
        <Zones>
            <ZoneId>ap-southeast-2a</ZoneId>
        </Zones>
    </TransitRouterAttachments>
</ListTransitRouterVpnAttachmentsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "NextToken" : "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId" : "3D5530D2-3BBB-524E-8E98-59AB06A250E4",
  "TotalCount" : 1,
  "MaxResults" : 20,
  "TransitRouterAttachments" : [ {
    "CreationTime" : "2022-07-08T08:45Z",
    "Status" : "Attached",
    "TransitRouterAttachmentId" : "tr-attach-a6p8voaodog5c0****",
    "TransitRouterId" : "tr-p0wm740vjnbaprv0m****",
    "VpnOwnerId" : 1210123456123456,
    "VpnId" : "vco-p0wtu1xgd0l7fjo7k****",
    "TransitRouterAttachmentDescription" : "desctest",
    "VpnRegionId" : "ap-southeast-2",
    "AutoPublishRouteEnabled" : true,
    "TransitRouterAttachmentName" : "nametest",
    "Zones" : [ {
      "ZoneId" : "ap-southeast-2a"
    } ]
  } ]
}

错误码

HttpCode 错误码 错误信息 描述
400 IllegalParam.NextToken The specified NextToken is invalid. NextToken是无效的。
400 IllegalParam.TrInstance The specified TransitRouter is invalid. TransitRouter是无效的。
400 IllegalParam.CenId The specified CenId is invalid. 云企业网实例ID非法。

访问错误中心查看更多错误码。