DescribeVpnConnections--VPN连接-火山引擎

文档中心

立即注册

导航

DescribeVpnConnections

最近更新时间：2024.09.25 15:57:09首次发布时间：2022.04.28 07:17:15

调用DescribeVpnConnections查询满足指定条件的IPsec连接。

调试

API Explorer

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

去调试

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DescribeVpnConnections	要执行的操作，取值：DescribeVpnConnections
Version	String	是	2020-04-01	API版本信息。
PageSize	Integer	否	20	分页查询时每页的行数。取值范围：1～100，默认值为20。
PageNumber	Integer	否	1	列表的页。如需传入此参数，请传入非负整数。不传或传入0，则均默认为1。
VpnConnectionIds.N	List of String	否	VpnConnectionIds.1=vgc-273zkshb2qayo7fap8t21**&VpnConnectionIds.2=vgc-qdifks098jodu3**	IPsec连接的ID。参数 - N：表示IPsec连接ID的序号。多个ID之间用&分隔。
VpnConnectionName	String	否	test-001	IPsec连接的名称。
VpnGatewayId	String	否	vgw-3tex2x1cwd4c6c0v****	IPsec连接关联的VPN网关的ID。您可调用DescribeVpnGateways查询VPN网关的ID信息。
CustomerGatewayId	String	否	cgw-3tehy13n2l4c6c0v****	IPsec连接关联的用户网关的ID。您可调用DescribeCustomerGateways查询用户网关的ID信息。
ProjectName	String	否	Project_1	IPsec连接所属的项目的名称。传入该字段，表示查询指定项目下的IPsec连接。不传入该字段，表示查询所有项目的IPsec连接。
AttachType	String	否	VpnGateway	IPsec连接关联资源的状态，即IPsec连接是否已关联资源。 VpnGateway：VPN网关 TransitRouter：中转路由器
AttachStatus	String	否	Attached	IPsec连接状态。 IPsec连接关联VpnGateway： Attached：已绑定 IPsec连接关联TransitRouter： Attached：已绑定 Attaching：绑定中 Detached：已解绑 Detaching：解绑中
TransitRouterId	String	否	tr-bp1osj4c1q84p7syi****	中转路由器的ID。您可调用DescribeTransitRouters查询中转路由器的ID信息。说明若`AttachType`传入值为`TransitRouter`，则可传入此参数进行精确搜索。若`AttachType`传入值为`VpnGateway`，无需传入此参数。
Spec	String	否	default	IPsec连接实例规格。 default：默认规格。 large：1G规格。
Status	String	否	Available	IPsec连接的状态。 Creating: 创建中 Deleting: 删除中 Pending：配置中 Available：可用

返回数据

名称	类型	示例值	描述
RequestId	String	20220322145233010225243081016A****	请求ID。
PageSize	Integer	20	当前分页的行数。
PageNumber	Integer	1	当前页码。
TotalCount	Integer	33	符合查询条件的IPsec连接的数量。
VpnConnections	Array of struct	-	IPsec连接的详细信息，具体请见下表“VpnConnection”。

VpnConnection

名称	类型	示例值	描述
RequestId	String	0ED8D006-F706-4D23-88ED-E11ED28D****	请求ID。
AccountId	String	2000****	IPsec连接所属账户的ID。
VpnConnectionId	String	vgc-3tehy13n2l4c6c0v****	IPsec连接的ID。
CreationTime	String	2021-04-09T08:36:47+08:00	创建IPsec连接的时间。
UpdateTime	String	2021-04-010T08:36:47+08:00	更新IPsec连接的时间。
VpnConnectionName	String	abc	IPsec连接的名称。
Description	String	This is a sample description	IPsec连接的描述信息。
Status	String	Available	IPsec连接的状态。 Creating: 创建中 Deleting: 删除中 Pending：配置中 Available：可用
VpnGatewayId	String	vgw-3tex2x1cwd4c6c0v****	IPsec连接关联的VPN网关的ID。
CustomerGatewayId	String	cgw-3tehy13n2l4c6c0v****	IPsec连接关联的用户网关的ID。
LocalSubnet	List	["10.0.XX.XX/24","10.0.XX.XX/24"]	IPsec连接的本端网段。
RemoteSubnet	List	["192.168.XX.XX/24","192.168.XX.XX/24"]	IPsec连接的对端网段。
DpdAction	String	clear	是否开启了DPD功能。 none：未开启DPD功能。 clear：已开启DPD功能，DPD超时后清除IKE SA。 hold：已开启DPD功能，DPD超时后保持当前状态，等待新的流量进入后重新建立连接。 restart：已开启DPD功能，DPD超时后立即重连。
ConnectStatus	String	ike_sa_negotiation_completed	IPsec连接的状态。 ike_sa_negotiation_failed：第一阶段协商未成功 ike_sa_negotiation_completed：第一阶段协商成功 ipsec_sa_negotiation_failed：第二阶段协商未成功 ipsec_sa_negotiation_completed：第二阶段协商成功
IkeConfig	Struct	-	IPsec连接的IKE配置的信息。具体请参见下表“IkeConfig”。
IpsecConfig	Struct	-	IPsec连接的IPsec配置的信息。具体请参见下表“IpsecConfig”。
NatTraversal	Boolean	false	是否开启了NAT穿越功能。 true：已开启。 false：未开启。
ProjectName	String	Project_1	IPsec连接所属的项目。
NegotiateInstantly	Boolean	true	是否立即发起协商模式。 true：IPsec连接配置完成后系统立即主动发起协商。 false：IPsec连接配置完成后系统不主动发起协商，当有流量通过时被动发起协商。
AttachStatus	String	Attached	IPsec连接状态。 VpnGateway： Attached：已绑定 TransitRouter： Attached：已绑定 Attaching：绑定中 Detached：已解绑 Detaching：解绑中
AttachType	String	VpnGateway	IPsec连接关联网关的类型。 VpnGateway：VPN网关 TransitRouter：中转路由器
IpAddress	String	180.XX.XX.182	中转路由器的公网IP地址，仅`AttachType`为“TransitRouter”时返回此参数。
TransitRouterId	String	tr-bp1osj4c1q84p7syi****	中转路由器的ID，仅`AttachType`为“TransitRouter”时返回此参数。
ZoneId	String	cn-beijing-a	中转路由器连接点的可用区，仅`AttachType`为“TransitRouter”时返回此参数。
BusinessStatus	String	Normal	IPsec连接的计费状态，仅`AttachType`为“TransitRouter”时返回此参数。 Normal: 正常。 FinancialLocked: 被锁定。
DeletedTime	String	2022-12-07 23:23:23	预期资源强制回收时间。仅`AttachType`为“TransitRouter”时返回此参数，且当资源因为欠费冻结，此参数才会有返回值，否则均返回空值。
OverdueTime	String	2022-12-07 23:23:23	资源冻结时间。仅`AttachType`为“TransitRouter”时返回此参数，且当资源因为欠费冻结，此参数才会有返回值，否则均返回空值。
LogEnabled	Boolean	false	是否启用了连接日志。 true：启用。 false：未启用。
Spec	String	default	IPsec连接实例规格。若`AttachType`为`VpnGateway`，则不返回此参数。 default：默认规格。 large：1G规格。
HealthCheckers	Struct	-	IPsec连接的健康检查的信息。具体请参见下表“HealthChecker”。
IsBlocked	Boolean	false	当前资源的状态是否被封禁。 true：封禁 false：未封禁
BgpInfo	Struct	-	IPsec连接的BGP信息。具体请参见下表“BgpInfo”。

IkeConfig

名称	类型	示例值	描述
Version	String	ikev1	IKE密钥交换协议的版本
Psk	String	12345***	预共享密钥，用于第一阶段VPN网关与用户网关之间的身份认证。
DhGroup	String	group2	第一阶段协商使用的DH（Diffie-Hellman）密钥交换算法。
Mode	String	main	第一阶段的协商模式。若IKE密钥交换协议的版本为ikev2时，此处返回空字符串。
EncAlg	String	aes	第一阶段协商的加密算法。
AuthAlg	String	sha1	第一阶段协商的认证算法。
LocalId	String	2.XX.XX.2	VPN网关的标识，用于第一阶段的协商。
RemoteId	String	1.XX.XX.1	用户网关的标识，用于第一阶段的协商。
Lifetime	Integer	86400	第一阶段协商的SA的生存时间，超过生存时间后，将重新发起协商。

IpsecConfig

名称	类型	示例值	描述
AuthAlg	String	sha1	第二阶段协商的认证算法。
EncAlg	String	aes	第二阶段协商的加密算法。
DhGroup	String	group2	第二阶段使用的DH（Diffie-Hellman）密钥交换算法。
Lifetime	Integer	86400	第二阶段协商的SA的生存时间，超过生存时间后，将重新发起协商。

HealthChecker

名称	类型	示例值	描述
CheckInterval	Integer	3	执行健康检查的时间间隔。
CheckResult	String	Up	健康检查结果。 Up：正常 Down：异常。
CheckerId	String	vhc-abc	IPsec连接健康检查的ID。
DownTime	Integer	3	健康检查的不健康阈值。当连续执行指定次数的健康检查，结果均为“异常”的IPsec连接，将被判定为健康检查异常。
LocalIp	String	100.XX.XX.10	健康检查源IP。
RemoteIp	String	100.XX.XX.10	健康检查目标IP。
Timeout	Integer	2	健康检查的响应超时时间。当IPsec连接在指定的响应时间内没有正确响应，则判定为健康检查“异常”。
UpTime	Integer	3	健康检查的健康阈值。当连续执行指定次数的健康检查，结果均为“正常”的IPsec连接将被判定为健康检查“正常”。

BgpInfo

名称	类型	示例值	描述
EnableBgp	Bool	true	是否开启BGP功能。 true：是，已开启 false：否，未开启
TunnelCidr	String	169.254.11.0/30	BGP会话本端IP和对端IP所在的 CIDR 地址段。
LocalBgpIp	String	169.254.XX.XX	BGP会话本端IP，即火山引擎侧的BGP地址。
PeerBgpIp	String	169.254.XX.XX	BGP会话对端IP，即用户网关侧的BGP地址。
SessionStatus	String	Up	BGP连接的状态。 Up：BGP连接正常 Down：BGP连接不通
LocalAsn	Integer	65534	VPN网关的ASN。
PeerAsn	Integer	42949	用户网关的ASN。

请求示例

GET /?Action=DescribeVpnConnections&Version=2020-04-01&VpnConnectionIds.1=vgc-2bzvqi8kerd342dx0eg2f****&PageNumber=1&PageSize=20 HTTP/1.1
Host: open.volcengineapi.com
ServiceName: vpn
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20220322145233010225243081016A****",
        "Action": "DescribeVpnConnections",
        "Version": "2020-04-01",
        "Service": "vpn",
        "Region": "cn-beijing"
    },
    "Result": {
        "RequestId": "20220322145233010225243081016A****",
        "PageNumber": 1,
        "PageSize": 20,
        "TotalCount": 1,
        "VpnConnections": [
            {
                "RequestId": "638cf5d5-04a7-4940-bb74-d51f9985****",
                "AccountId": "210000****",
                "VpnConnectionId": "vgc-2bzvqi8kerd342dx0eg2f****",
                "VpnConnectionName": "test",
                "CreationTime": "2022-03-13T17:50:42+08:00",
                "UpdateTime": "2022-03-18T06:31:21+08:00",
                "Description": "test",
                "Status": "Available",
                "VpnGatewayId": "vgw-2d670iixygs8w58ozfde1****",
                "CustomerGatewayId": "cgw-2d670j4napdz458ozfd8y****",
                "ProjectName":"Project_1",
                "LocalSubnet": [
                    "192.XX.XX.0/16"
                ],
                "RemoteSubnet": [
                    "172.XX.XX.0/16"
                ],
                "NatTraversal": false,
                "DpdAction": "clear",
                "ConnectStatus": "ike_sa_negotiation_completed",
                "NegotiateInstantly": true,
                "AttachStatus": "Attached",
                "AttachType": "VpnGateway",
                "LogEnabled": false,
                "IsBlocked": false,
                "IkeConfig": {
                    "Version": "ikev2",
                    "Psk": "12345",
                    "DhGroup": "group2",
                    "Mode": "main",
                    "EncAlg": "aes",
                    "AuthAlg": "sha1",
                    "Lifetime": 86400,
                    "LocalId": "2.XX.XX.2",
                    "RemoteId": "1.XX.XX.1"
                },
		            "IpsecConfig": {
                    "EncAlg": "aes",
                    "AuthAlg": "sha1",
                    "Lifetime": 86400,
                    "DhGroup": "group2"
                },
		          "HealthCheckers": [
		             {
		                "CheckerId": "vhc-inb9bswzfksg8gbss****",
		                "LocalIp": "100.XX.XX.12",
		                "RemoteIp": "100.XX.XX.10",
		                "CheckInterval": 3,
		                "Timeout": 1,
		                "UpTime": 3,
		                "DownTime": 3,
		                "CheckResult": "Down"
		               }
		            ],
		          "BgpInfo": [
			            {
		                "EnableBgp":"true" ,
		                "LocalAsn": 65543,
		                "LocalBgpIp": "169.254.XX.1",
		                "PeerAsn": 42949,
		                "PeerBgpIp": "169.254.XX.2",
		                "SessionStatus": "Up",
		                "TunnelCidr": "169.254.XX.0/30"
		            }
		          ]  
		       }
	     ]
   }
}

错误码

此处仅展示当前API的错误码，更多错误码请参见公共错误码。

HttpCode	错误码	错误信息	描述
400	InvalidPage.Malformed	The specified page is malformed.	指定的分页参数不合法。
400	LimitExceeded.VpnConnectionId	You've reached the limit on the number of IPSec connection IDs that you can describe.	已达到可查询的IPSec连接ID数量上限。