调用DescribeVpnConnections接口查询IPsec连接信息。

调试

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

请求参数

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

系统规定参数。取值:DescribeVpnConnections

RegionId String cn-hangzhou

IPsec连接所在的地域ID。

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

VpnGatewayId String vpn-bp1q8bgx4xnkx****

VPN网关实例ID。

CustomerGatewayId String cgw-bp1mvj4g9kogw****

用户网关ID。

PageNumber Integer 1

列表的页码。默认值:1

PageSize Integer 10

分页查询时每页显示的条目数。默认值:10,取值范围:1~50

VpnConnectionId String vco-bp10lz7aejumd****

IPsec连接的ID。

返回数据

名称 类型 示例值 描述
PageSize Integer 10

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

RequestId String 238752DC-0693-49BE-9C85-711D5691D3E5

请求ID。

PageNumber Integer 1

列表的页码。

TotalCount Integer 2

列表的条目数。

VpnConnections Array of VpnConnection

IPsec连接的配置信息列表。

VpnConnection
Status String ipsec_sa_established

连接状态。

  • ike_sa_not_established:第一阶段协商失败。
  • ike_sa_established:第一阶段协商成功。
  • ipsec_sa_not_established:第二阶段协商失败。
  • ipsec_sa_established:第二阶段协商成功。
EnableNatTraversal Boolean true

是否开启NAT穿越功能。

  • true:开启NAT穿越功能。

    开启后,IKE协商过程会删除对UDP端口号的验证过程,同时实现对VPN隧道中NAT网关设备的发现功能。

  • false:不开启NAT穿越功能。
RemoteCaCertificate String -----BEGIN CERTIFICATE----- MIIB7zCCAZW****

对端的CA证书。

CreateTime Long 1492753817000

创建IPsec连接的时间戳。单位:毫秒。

时间戳的格式采用Unix时间戳,表示从格林威治时间1970年01月01日00时00分00秒至创建IPsec连接时的总时长。

EffectImmediately Boolean true

IPsec连接的配置是否立即生效。

  • true:是,配置变更完成后触发重连。
  • false:否,有流量时触发重连。
VpnGatewayId String vpn-bp1q8bgx4xnkm****

VPN网关的实例ID。

LocalSubnet String 192.168.0.0/16,172.17.0.0/16

IPsec连接阿里云侧的网段。

在多个网段的情况下,网段之间使用半角逗号(,)分隔。

VpnConnectionId String vco-bp10lz7aejumd****

IPsec连接的ID。

RemoteSubnet String 10.0.0.0/8,172.16.0.0/16

IPsec连接本地数据中心侧的网段。

在多个网段的情况下,网段之间使用半角逗号(,)分隔。

CustomerGatewayId String cgw-bp1mvj4g9kogw****

用户网关的实例ID。

Name String nametest

IPsec连接的名称。

EnableDpd Boolean true

是否开启DPD(对等体存活检测)功能。

  • true:开启DPD功能。

    IPsec发起端会发送DPD报文用来检测对端的设备是否存活,如果在设定时间内未收到正确回应则认为对端已经断线,IPsec将删除ISAKMP SA和相应的IPsec SA,安全隧道同样也会被删除。

  • false:不开启DPD功能,IPsec发起端不会发送DPD探测报文。
IkeConfig Object

第一阶段协商的配置。

RemoteId String 139.17.XX.XX

IPsec连接阿里云侧的标识。

IkeLifetime Long 86400

IKE生存时间。单位:秒。

IkeEncAlg String aes

IKE加密算法。

LocalId String 116.64.XX.XX

IPsec连接本地数据中心侧的标识。

IkeMode String main

IKE协商模式。

  • main:主模式,协商过程安全性高。
  • aggressive:野蛮模式,协商快速且协商成功率高。
IkeVersion String ikev1

IKE协议版本。

  • ikev1
  • ikev2

相对于IKEv1版本,IKEv2版本简化了SA的协商过程并且对于多网段的场景提供了更好的支持。

IkePfs String group2

DH分组。

Psk String pgw6dy7****

预共享密钥。

IkeAuthAlg String sha1

IKE认证算法。

IpsecConfig Object

第二阶段协商的配置。

IpsecAuthAlg String sha1

IPsec认证算法。

IpsecLifetime Long 86400

IPsec生存时间。单位:秒。

IpsecEncAlg String aes

IPsec加密算法。

IpsecPfs String group2

DH分组。

VcoHealthCheck Object

健康检查配置。

Status String success

健康检查状态。

  • success:正常。
  • failed:异常。
Dip String 192.168.0.1

目的IP地址。

Interval Integer 2

健康检查的时间间隔。单位:秒。

Retry Integer 3

健康检查的重试发包次数。

Sip String 192.168.0.50

源IP地址。

Enable String true

健康检查的开启状态。

  • true:已开启。
  • false:未开启。
Policy String revoke_route

健康检查失败时是否撤销已发布的路由。

  • revoke_route:撤销路由。
  • reserve_route:不撤销路由。
VpnBgpConfig Object

BGP路由协议的配置。

Status String success

BGP路由协议的协商状态。

  • success:正常。
  • false:异常。
PeerBgpIp String 169.30.XX.XX

对端BGP地址。

TunnelCidr String 169.254.10.0/30

IPsec隧道网段。该网段是一个在169.254.0.0/16内的子网掩码长度为30的网段。

LocalBgpIp String 169.32.XX.XX

阿里云侧BGP地址。

PeerAsn Long 65535

对端自治系统号。

LocalAsn Long 45104

阿里云侧自治系统号。

AuthKey String AuthKey****

BGP路由协议的认证密钥。

AttachType String CEN

IPsec连接绑定的资源类型。

  • CEN:表示IPsec连接已绑定云企业网实例下的转发路由器实例。
  • NO_ASSOCIATED:表示IPsec连接未绑定任何资源。
  • VPNGW:表示IPsec连接绑定了VPN网关实例。
NetworkType String public

IPsec连接的网络类型。

  • public:公网,表示IPsec连接通过公网建立加密通信通道。
  • private:私网,表示IPsec连接通过私网建立加密通信通道。
AttachInstanceId String cen-lxxpbpalc776qz****

转发路由器实例所属的云企业网实例ID。

Spec String 1000M

IPsec连接的带宽规格。单位:Mbps

State String attached

IPsec连接的状态。

  • active:IPsec连接已与VPN网关实例绑定,状态正常。
  • init:IPsec连接未绑定任何资源,IPsec连接初始化。
  • attaching:IPsec连接与转发路由器实例绑定中。
  • attached:IPsec连接已与转发路由器实例绑定。
  • detaching:IPsec连接与转发路由器实例解绑中。
  • financialLocked:欠费锁定。
  • provisioning:资源准备中。
  • updating:更新中。
  • upgrading:升级中。
  • deleted:已删除。
TransitRouterId String tr-p0we2edef9qr44a85****

IPsec连接绑定的转发路由器实例ID。

TransitRouterName String nametest

转发路由器实例的名称。

CrossAccountAuthorized Boolean false

IPsec连接是否绑定了跨账号的转发路由器实例。

  • true:是。
  • false:否。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeVpnConnections
&RegionId=cn-hangzhou
&VpnGatewayId=vpn-bp1q8bgx4xnkx****
&CustomerGatewayId=cgw-bp1mvj4g9kogw****
&PageNumber=1
&PageSize=10
&VpnConnectionId=vco-bp10lz7aejumd****
&公共请求参数

正常返回示例

XML格式

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

<DescribeVpnConnectionsResponse>
    <PageSize>10</PageSize>
    <RequestId>238752DC-0693-49BE-9C85-711D5691D3E5</RequestId>
    <PageNumber>1</PageNumber>
    <TotalCount>2</TotalCount>
    <VpnConnections>
        <Status>ipsec_sa_established</Status>
        <EnableNatTraversal>true</EnableNatTraversal>
        <RemoteCaCertificate>-----BEGIN CERTIFICATE----- MIIB7zCCAZW****</RemoteCaCertificate>
        <CreateTime>1492753817000</CreateTime>
        <EffectImmediately>true</EffectImmediately>
        <VpnGatewayId>vpn-bp1q8bgx4xnkm****</VpnGatewayId>
        <State>active</State>
        <LocalSubnet>192.168.0.0/16,172.17.0.0/16</LocalSubnet>
        <VpnConnectionId>vco-bp10lz7aejumd****</VpnConnectionId>
        <RemoteSubnet>10.0.0.0/8,172.16.0.0/16</RemoteSubnet>
        <CustomerGatewayId>cgw-bp1mvj4g9kogw****</CustomerGatewayId>
        <Name>nametest</Name>
        <EnableDpd>true</EnableDpd>
        <IkeConfig>
            <RemoteId>139.17.XX.XX</RemoteId>
            <IkeLifetime>86400</IkeLifetime>
            <IkeEncAlg>aes</IkeEncAlg>
            <LocalId>116.64.XX.XX</LocalId>
            <IkeMode>main</IkeMode>
            <IkeVersion>ikev1</IkeVersion>
            <IkePfs>group2</IkePfs>
            <Psk>pgw6dy7****</Psk>
            <IkeAuthAlg>sha1</IkeAuthAlg>
        </IkeConfig>
        <IpsecConfig>
            <IpsecAuthAlg>sha1</IpsecAuthAlg>
            <IpsecLifetime>86400</IpsecLifetime>
            <IpsecEncAlg>aes</IpsecEncAlg>
            <IpsecPfs>group2</IpsecPfs>
        </IpsecConfig>
        <VcoHealthCheck>
            <Status>success</Status>
            <Dip>192.168.0.1</Dip>
            <Interval>2</Interval>
            <Retry>3</Retry>
            <Sip>192.168.0.50</Sip>
            <Enable>true</Enable>
        </VcoHealthCheck>
        <VpnBgpConfig>
            <Status>success</Status>
            <PeerBgpIp>169.30.XX.XX</PeerBgpIp>
            <TunnelCidr>169.254.10.0/30</TunnelCidr>
            <LocalBgpIp>169.32.XX.XX</LocalBgpIp>
            <PeerAsn>65535</PeerAsn>
            <LocalAsn>45104</LocalAsn>
            <AuthKey>AuthKey****</AuthKey>
        </VpnBgpConfig>
    </VpnConnections>
</DescribeVpnConnectionsResponse>

JSON格式

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

{
  "PageSize" : 10,
  "RequestId" : "238752DC-0693-49BE-9C85-711D5691D3E5",
  "PageNumber" : 1,
  "TotalCount" : 2,
  "VpnConnections" : [ {
    "Status" : "ipsec_sa_established",
    "EnableNatTraversal" : true,
    "RemoteCaCertificate" : "-----BEGIN CERTIFICATE----- MIIB7zCCAZW****",
    "CreateTime" : 1492753817000,
    "EffectImmediately" : true,
    "VpnGatewayId" : "vpn-bp1q8bgx4xnkm****",
    "State" : "active",
    "LocalSubnet" : "192.168.0.0/16,172.17.0.0/16",
    "VpnConnectionId" : "vco-bp10lz7aejumd****",
    "RemoteSubnet" : "10.0.0.0/8,172.16.0.0/16",
    "CustomerGatewayId" : "cgw-bp1mvj4g9kogw****",
    "Name" : "nametest",
    "EnableDpd" : true,
    "IkeConfig" : {
      "RemoteId" : "139.17.XX.XX",
      "IkeLifetime" : 86400,
      "IkeEncAlg" : "aes",
      "LocalId" : "116.64.XX.XX",
      "IkeMode" : "main",
      "IkeVersion" : "ikev1",
      "IkePfs" : "group2",
      "Psk" : "pgw6dy7****",
      "IkeAuthAlg" : "sha1"
    },
    "IpsecConfig" : {
      "IpsecAuthAlg" : "sha1",
      "IpsecLifetime" : 86400,
      "IpsecEncAlg" : "aes",
      "IpsecPfs" : "group2"
    },
    "VcoHealthCheck" : {
      "Status" : "success",
      "Dip" : "192.168.0.1",
      "Interval" : 2,
      "Retry" : 3,
      "Sip" : "192.168.0.50",
      "Enable" : "true"
    },
    "VpnBgpConfig" : {
      "Status" : "success",
      "PeerBgpIp" : "169.30.XX.XX",
      "TunnelCidr" : "169.254.10.0/30",
      "LocalBgpIp" : "169.32.XX.XX",
      "PeerAsn" : "65535",
      "LocalAsn" : 45104,
      "AuthKey" : "AuthKey****"
    }
  } ]
}

错误码

HttpCode 错误码 错误信息 描述
403 Forbbiden.SubUser User not authorized to operate on the specified resource as your account is created by another user. 您没有权限操作该资源,请您申请操作权限后再试。
403 Forbidden User not authorized to operate on the specified resource. 您没有权限操作指定资源,请申请权限后再操作。

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