VPN连接
VPN连接
文档指南
请输入
- 文档首页
VPN连接API参考IPsec连接DescribeVpnConnections-查询IPsec连接
复制全文
下载 pdfDescribeVpnConnections-查询IPsec连接
文档反馈
问问助手调用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 String 可选 示例值：vgc-273zkshb2qayo7fap8t21****
IPsec连接的ID。
- 参数 - N：表示IPsec连接ID的序号。
- 多个ID之间用&分隔。
VpnConnectionName String 可选 示例值：test-001
IPsec连接的名称。
VpnGatewayId String 可选 示例值：vgw-3tex2x1cwd4c6c0v****
CustomerGatewayId String 可选 示例值：cgw-3tehy13n2l4c6c0v****
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****
说明
若AttachType传入值为TransitRouter，则可传入此参数进行精确搜索。若AttachType传入值为VpnGateway，无需传入此参数。
Spec String 可选 示例值：default
IPsec连接实例规格。
- default：默认规格，带宽上限为200 Mbps。
- large：大型规格，带宽上限为1Gbps。
- xlarge：超大型规格，带宽上限为3Gbps。
说明
大型和超大型规格当前为邀测阶段，仅开启后可使用，如需试用请联系客户经理开通。
Status String 可选 示例值：Available
IPsec连接的状态。
- Creating: 创建中
- Deleting: 删除中
- Pending：配置中
- Available：可用
TagFilters.N.Key String 可选 示例值：key1
根据标签查询资源时指定的标签键。
- 参数 - N：表示标签键的序号，取值范围：1～10。
- 多个标签键之间用&分隔。
- 不允许重复。
TagFilters.N.Values.M String 可选 示例值：value1
根据标签查询资源时指定的标签值。
- 第一个 N：表示标签键的序号，取值范围：1～10。
- 第二个 N：表示标签值的序号，取值范围：1～3，即同一标签键最多支持同时查询3个标签值。
- 多个标签值之间用&分隔。
- 如果传入该参数，则必须先传入TagFilters.N.Key。
- 如果不传该参数仅传入TagFilters.N.Key，表示查询同一标签键下的所有标签值。
- 传入空字符串时，表示查询标签值为空的标签。
- 如果同一个TagFilters.N.Key传入多个TagFilters.N.Values.N，多个TagFilters.N.Values.N之间的关系为逻辑“或(OR)”。
返回参数
RequestId String 示例值：20220322145233010225243081016A****
请求ID。
PageSize Integer 示例值：20
当前分页的行数。
PageNumber Integer 示例值：1
当前页码。
TotalCount Integer 示例值：33
符合查询条件的IPsec连接的数量。
VpnConnections Object[] 示例值：-
IPsec连接的详细信息。
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 String[] 示例值：10.0.XX.XX/24
IPsec连接的本端网段。
RemoteSubnet String[] 示例值：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 Object 示例值：-
IPsec连接的IKE配置的信息。
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 Object 示例值：-
IPsec连接的IPsec配置的信息。
AuthAlg String 示例值：sha1
第二阶段协商的认证算法。
EncAlg String 示例值：aes
第二阶段协商的加密算法。
DhGroup String 示例值：group2
第二阶段使用的DH（Diffie-Hellman）密钥交换算法。
Lifetime Integer 示例值：86400
第二阶段协商的SA的生存时间，超过生存时间后，将重新发起协商。
NatTraversal Boolean 示例值：false
是否开启了NAT穿越功能。
- true：已开启。
- false：未开启。
DualTunnelEnabled Boolean 示例值：true
是否开启双隧道模式。
- true：开启
- false（默认值）：关闭
TunnelOptions Object[] 示例值：-
双隧道IPsec连接的配置信息。
TunnelId String 示例值：tunnel-3tehy13n2l4c6c0v****
隧道连接的ID。
Role String 示例值：Primary
隧道的角色信息。
- primary：表示当前隧道为主隧道。
- secondary：表示当前隧道为备隧道。
CustomerGatewayId String 示例值：cgw-3tehy13n2l4c6c0v****
IPsec连接关联的用户网关的ID。
ConnectStatus String 示例值：ike_sa_negotiation_completed
tunnel连接的状态。
- ike_sa_negotiation_failed：第一阶段协商未成功
- ike_sa_negotiation_completed：第一阶段协商成功
- ipsec_sa_negotiation_failed：第二阶段协商未成功
- ipsec_sa_negotiation_completed：第二阶段协商成功
IkeConfig Object 示例值：-
IPsec连接的IKE配置的信息。
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 Object 示例值：-
IPsec连接的IPsec配置的信息。
AuthAlg String 示例值：sha1
第二阶段协商的认证算法。
EncAlg String 示例值：aes
第二阶段协商的加密算法。
DhGroup String 示例值：group2
第二阶段使用的DH（Diffie-Hellman）密钥交换算法。
Lifetime Integer 示例值：86400
第二阶段协商的SA的生存时间，超过生存时间后，将重新发起协商。
NatTraversal Boolean 示例值：false
是否开启了NAT穿越功能。
- true：已开启。
- false：未开启。
DpdMode String 示例值：on_demand
IPsec连接的DPD探测方式。
- on_demand：按需。
- periodic：周期。
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”时返回此参数。
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：默认规格，带宽上限为200 Mbps。
- large：大型规格，带宽上限为1Gbps。
- xlarge：超大型规格，带宽上限为3Gbps。
HealthCheckers Object[] 示例值：-
IPsec连接的健康检查的信息。
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连接将被判定为健康检查“正常”。
IsBlocked Boolean 示例值：false
当前资源的状态是否被封禁。
- true：封禁
- false：未封禁
BgpInfo Object 示例值：-
IPsec连接的BGP信息。
EnableBgp Boolean 示例值：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。
Tags Object[] 示例值：-
IPsec连接已添加的全部标签信息。
Key String 示例值：key1
标签键。
Value String 示例值：value1
标签值。
ProjectName String 示例值：default
IPsec连接的项目名称。
ExpectedOverdueTime String 示例值：2024-05-18T14:00:00+08:00
资源冻结时间。仅当资源因为欠费冻结，此参数才会有返回值。
请求示例
返回示例
错误码
最近更新时间：2026.09.18 15:13:19
这个页面对您有帮助吗？
有用
有用
无用
无用