调用DescribeVpnConnection接口查询指定的IPsec连接的信息-阿里云帮助中心

调试

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

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DescribeVpnConnection	系统规定参数。取值：DescribeVpnConnection。
RegionId	String	是	cn-hangzhou	IPsec连接所在的地域ID。您可以通过调用DescribeRegions接口获取地域ID。
VpnConnectionId	String	是	vco-bp1bbi27hojx80nck****	IPsec连接的ID。

返回数据

名称	类型	示例值	描述
Status	String	ike_sa_not_established	IPsec连接的状态。 ike_sa_not_established：第一阶段协商失败。 ike_sa_established：第一阶段协商成功。 ipsec_sa_not_established：第二阶段协商失败。 ipsec_sa_established：第二阶段协商成功。
RemoteCaCertificate	String	-----BEGIN CERTIFICATE----- MIIB7zCCAZW****	对端的CA证书。
EnableNatTraversal	Boolean	true	IPsec连接是否已开启NAT穿越功能。 true：开启NAT穿越功能。 false：不开启NAT穿越功能。开启NAT穿越功能后，IKE协商过程会删除对UDP端口号的验证过程，同时实现对VPN隧道中NAT网关设备的发现功能。
CreateTime	Long	1492753817000	创建IPsec连接的时间戳。单位：毫秒。时间戳的格式采用Unix时间戳，表示从格林威治时间1970年01月01日00时00分00秒至创建IPsec连接时的总时长。
EffectImmediately	Boolean	true	IPsec连接的配置是否立即生效。 true：是，配置变更完成后触发重连。 false：否，有流量时触发重连。
VpnGatewayId	String	vpn-bp1q8bgx4xnkm2ogj****	VPN网关的实例ID。
LocalSubnet	String	10.0.0.0/8	IPsec连接阿里云侧的网段。在多个网段的情况下，网段之间使用半角逗号（,）分隔。
RequestId	String	F2310D45-BCF6-4E2E-9082-B4503844BA4C	请求ID。
VpnConnectionId	String	vco-bp1bbi27hojx80nck****	IPsec连接的ID。
RemoteSubnet	String	192.168.0.0/16	本地数据中心侧的网段。在多个网段的情况下，网段之间使用半角逗号（,）分隔。
CustomerGatewayId	String	cgw-bp1mvj4g9kogwwcxk****	IPsec连接关联的用户网关ID。
Name	String	ipsec1	IPsec连接的名称。
EnableDpd	Boolean	true	IPsec连接是否已开启DPD（对等体存活检测）功能。 false：未开启。 true：已开启。开启DPD功能后，IPsec发起端会发送DPD报文用来检测对端的设备是否存活，如果在设定时间内未收到正确回应则认为对端已经断线，IPsec将删除ISAKMP SA和相应的IPsec SA，安全隧道同样也会被删除。
IkeConfig	Object		第一阶段协商的配置。
RemoteId	String	139.34.XX.XX	IPsec连接本地数据中心侧的标识。
IkeLifetime	Long	86400	IKE阶段生存时间。单位：秒。
IkeEncAlg	String	aes	IKE阶段加密算法。
LocalId	String	116.28.XX.XX	IPsec连接阿里云侧的标识。
IkeMode	String	main	IKE协商模式。 main：主模式，协商过程安全性高。 aggressive：野蛮模式，协商快速且协商成功率高。
IkeVersion	String	ikev1	IKE协议版本。 ikev1 ikev2 相对于IKEv1版本，IKEv2版本简化了SA的协商过程并且对于多网段的场景提供了更好的支持。
IkePfs	String	group2	IKE阶段DH分组。
Psk	String	pgw6dy****	预共享密钥。
IkeAuthAlg	String	sha1	IKE阶段认证算法。
IpsecConfig	Object		第二阶段协商的配置。
IpsecAuthAlg	String	sha1	IPsec阶段认证算法。
IpsecLifetime	Long	86400	IPsec阶段生存时间。单位：秒。
IpsecEncAlg	String	aes	IPsec阶段加密算法。
IpsecPfs	String	group2	IPsec阶段DH分组。
VcoHealthCheck	Object		IPsec连接的健康检查信息。
Status	String	failed	健康检查状态。 failed：异常。 success：正常。
Dip	String	10.0.0.1	目标IP地址。
Interval	Integer	3	健康检查的重试间隔时间，单位：秒。
Retry	Integer	3	健康检查的重试发包次数。
Sip	String	192.168.1.1	源IP地址。
Enable	String	true	IPsec连接是否已开启健康检查。 false：未开启。 true：已开启。
Policy	String	revoke_route	健康检查失败时是否撤销已发布的路由。 revoke_route：撤销路由。 reserve_route：不撤销路由。
VpnBgpConfig	Object		IPsec连接BGP路由协议的配置信息。
Status	String	success	BGP路由协议的协商状态。 success：正常。 failed：异常。
PeerBgpIp	String	169.254.11.1	对端BGP地址。
TunnelCidr	String	169.254.11.0/30	IPsec连接BGP网段。该网段是一个在169.254.0.0/16内的子网掩码长度为30的网段。
EnableBgp	String	true	BGP路由协议的开启状态。 true：已开启。 false：未开启。
LocalBgpIp	String	169.254.11.2	阿里云侧BGP地址。
PeerAsn	Long	65530	对端自治系统号。
LocalAsn	Long	65531	阿里云侧自治系统号。
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：已删除。
ZoneNo	String	ap-southeast-2b	IPsec连接被部署的可用区ID。您可以调用DescribeZones接口查询可用区ID和可用区的对应关系。
InternetIp	String	47.XX.XX.162	IPsec连接的网关IP地址。
TransitRouterId	String	tr-p0we2edef9qr44a85****	IPsec连接绑定的转发路由器实例ID。
TransitRouterName	String	nametest	转发路由器实例的名称。
CrossAccountAuthorized	Boolean	false	IPsec连接是否绑定了跨账号的转发路由器实例。 true：是。 false：否。
Tags	Array of Tag		IPsec连接绑定的标签列表。
Tag
Key	String	TagKey	标签键。
Value	String	TagValue	标签值。
TunnelOptionsSpecification	Array of TunnelOptions		IPsec连接的隧道配置信息。仅查询双隧道模式的IPsec连接会返回TunnelOptionsSpecification数组下的参数。
TunnelOptions
TunnelId	String	tun-opsqc4d97wni27****	隧道ID。
CustomerGatewayId	String	cgw-p0wy363lucf1uyae8****	隧道关联的用户网关ID。
EnableDpd	String	true	隧道是否已开启DPD（对等体存活检测）功能。 false：未开启。 true：已开启。
EnableNatTraversal	String	true	隧道是否已开启NAT穿越功能。 false：未开启。 true：已开启。
InternetIp	String	47.21.XX.XX	隧道的IP地址。
RemoteCaCertificate	String	-----BEGIN CERTIFICATE----- MIIB7zCCAZW**** -----END CERTIFICATE-----	隧道对端的CA证书。仅VPN网关实例的类型为国密型时才会返回当前参数。
Role	String	master	隧道的角色。 master：表示当前隧道为主隧道。 slave：表示当前隧道为备隧道。
State	String	active	隧道的状态。 active：状态正常。 updating：更新中。 deleting：删除中。
Status	String	ipsec_sa_established	IPsec连接的状态。 ike_sa_not_established：第一阶段协商失败。 ike_sa_established：第一阶段协商成功。 ipsec_sa_not_established：第二阶段协商失败。 ipsec_sa_established：第二阶段协商成功。
TunnelBgpConfig	Object		隧道的BGP配置信息。
BgpStatus	String	success	BGP的协商状态。 success：正常。 false：异常。
LocalAsn	String	65530	隧道本端（阿里云侧）的自治系统号。
LocalBgpIp	String	169.254.10.1	隧道本端（阿里云侧）的BGP地址。
PeerAsn	String	65531	隧道对端的自治系统号。
PeerBgpIp	String	169.254.10.2	隧道对端的BGP地址。
TunnelCidr	String	169.254.10.0/30	隧道的BGP网段。
TunnelIkeConfig	Object		第一阶段协商的配置。
IkeAuthAlg	String	sha1	IKE阶段认证算法。
IkeEncAlg	String	aes	IKE阶段加密算法。
IkeLifetime	String	86400	IKE阶段生存时间。单位：秒。
IkeMode	String	main	IKE协商模式。 main：主模式，协商过程安全性高。 aggressive：野蛮模式，协商快速且协商成功率高。
IkePfs	String	group2	IKE阶段DH分组。
IkeVersion	String	ikev1	IKE协议版本。
LocalId	String	47.21.XX.XX	隧道本端（阿里云侧）的标识。
Psk	String	123456****	预共享密钥。
RemoteId	String	47.42.XX.XX	隧道对端的标识。
TunnelIpsecConfig	Object		第二阶段协商的配置。
IpsecAuthAlg	String	sha1	IPsec阶段认证算法。
IpsecEncAlg	String	aes	IPsec阶段加密算法。
IpsecLifetime	String	86400	IPsec阶段生存时间。单位：秒。
IpsecPfs	String	group2	IPsec阶段DH分组。
ZoneNo	String	ap-southeast-5a	隧道部署的可用区。您可以调用DescribeZones接口查询可用区ID和可用区的对应关系。
EnableTunnelsBgp	Boolean	true	隧道BGP的开启状态。 true：已开启。 false：未开启。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeVpnConnection
&RegionId=cn-hangzhou
&VpnConnectionId=vco-bp1bbi27hojx80nck****
&公共请求参数

正常返回示例

XML格式

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

<DescribeVpnConnectionResponse>
    <Status>ike_sa_not_established</Status>
    <RemoteCaCertificate>-----BEGIN CERTIFICATE----- MIIB7zCCAZW****</RemoteCaCertificate>
    <EnableNatTraversal>true</EnableNatTraversal>
    <CreateTime>1492753817000</CreateTime>
    <EffectImmediately>true</EffectImmediately>
    <VpnGatewayId>vpn-bp1q8bgx4xnkm2ogj****</VpnGatewayId>
    <State>active</State>
    <LocalSubnet>10.0.0.0/8</LocalSubnet>
    <RequestId>F2310D45-BCF6-4E2E-9082-B4503844BA4C</RequestId>
    <VpnConnectionId>vco-bp1bbi27hojx80nck****</VpnConnectionId>
    <RemoteSubnet>192.168.0.0/16</RemoteSubnet>
    <CustomerGatewayId>cgw-bp1mvj4g9kogwwcxk****</CustomerGatewayId>
    <Name>ipsec1</Name>
    <EnableDpd>true</EnableDpd>
    <IkeConfig>
        <RemoteId>139.34.XX.XX</RemoteId>
        <IkeLifetime>86400</IkeLifetime>
        <IkeEncAlg>aes</IkeEncAlg>
        <LocalId>116.28.XX.XX</LocalId>
        <IkeMode>main</IkeMode>
        <IkeVersion>ikev1</IkeVersion>
        <IkePfs>group2</IkePfs>
        <Psk>pgw6dy****</Psk>
        <IkeAuthAlg>sha1</IkeAuthAlg>
    </IkeConfig>
    <IpsecConfig>
        <IpsecAuthAlg>sha1</IpsecAuthAlg>
        <IpsecLifetime>86400</IpsecLifetime>
        <IpsecEncAlg>aes</IpsecEncAlg>
        <IpsecPfs>group2</IpsecPfs>
    </IpsecConfig>
    <VcoHealthCheck>
        <Status>failed</Status>
        <Dip>10.0.0.1</Dip>
        <Interval>3</Interval>
        <Retry>3</Retry>
        <Sip>192.168.1.1</Sip>
        <Enable>true</Enable>
    </VcoHealthCheck>
    <VpnBgpConfig>
        <Status>success</Status>
        <PeerBgpIp>169.254.11.1</PeerBgpIp>
        <TunnelCidr>169.254.11.0/30</TunnelCidr>
        <EnableBgp>true</EnableBgp>
        <LocalBgpIp>169.254.11.2</LocalBgpIp>
        <PeerAsn>65530</PeerAsn>
        <LocalAsn>65531</LocalAsn>
        <AuthKey>AuthKey****</AuthKey>
    </VpnBgpConfig>
</DescribeVpnConnectionResponse>

JSON格式

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

{
  "Status" : "ike_sa_not_established",
  "RemoteCaCertificate" : "-----BEGIN CERTIFICATE----- MIIB7zCCAZW****",
  "EnableNatTraversal" : true,
  "CreateTime" : 1492753817000,
  "EffectImmediately" : true,
  "VpnGatewayId" : "vpn-bp1q8bgx4xnkm2ogj****",
  "State" : "active",
  "LocalSubnet" : "10.0.0.0/8",
  "RequestId" : "F2310D45-BCF6-4E2E-9082-B4503844BA4C",
  "VpnConnectionId" : "vco-bp1bbi27hojx80nck****",
  "RemoteSubnet" : "192.168.0.0/16",
  "CustomerGatewayId" : "cgw-bp1mvj4g9kogwwcxk****",
  "Name" : "ipsec1",
  "EnableDpd" : true,
  "IkeConfig" : {
    "RemoteId" : "139.34.XX.XX",
    "IkeLifetime" : 86400,
    "IkeEncAlg" : "aes",
    "LocalId" : "116.28.XX.XX",
    "IkeMode" : "main",
    "IkeVersion" : "ikev1",
    "IkePfs" : "group2",
    "Psk" : "pgw6dy****",
    "IkeAuthAlg" : "sha1"
  },
  "IpsecConfig" : {
    "IpsecAuthAlg" : "sha1",
    "IpsecLifetime" : 86400,
    "IpsecEncAlg" : "aes",
    "IpsecPfs" : "group2"
  },
  "VcoHealthCheck" : {
    "Status" : "failed",
    "Dip" : "10.0.0.1",
    "Interval" : 3,
    "Retry" : 3,
    "Sip" : "192.168.1.1",
    "Enable" : "true"
  },
  "VpnBgpConfig" : {
    "Status" : "success",
    "PeerBgpIp" : "169.254.11.1",
    "TunnelCidr" : "169.254.11.0/30",
    "EnableBgp" : "true",
    "LocalBgpIp" : "169.254.11.2",
    "PeerAsn" : 65530,
    "LocalAsn" : 65531,
    "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.	您没有权限操作指定资源，请申请权限后再操作。
404	InvalidVpnConnectionInstanceId.NotFound	The specified vpn connection instance id does not exist.	指定的VPN连接不存在，请您检查该VPN连接ID是否正确。

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