全部产品
Search

搜索本产品

    VPN网关：ModifyVpnConnectionAttribute - 修改IPsec连接的配置信息

    文档中心

    VPN网关：ModifyVpnConnectionAttribute - 修改IPsec连接的配置信息

    更新时间：Nov 27, 2024

    调用ModifyVpnConnectionAttribute接口修改IPsec连接的配置信息。

    接口说明

    • 如果要修改双隧道模式的 IPsec-VPN 连接，调用ModifyVpnConnectionAttribute接口时除支持配置必填参数外，还支持配置以下请求参数：

      ClientToken、Name、 LocalSubnet、RemoteSubnet、EffectImmediately、AutoConfigRoute、TunnelOptionsSpecification 数组、EnableTunnelsBgp。

    • 如果要修改单隧道模式的 IPsec-VPN 连接，调用ModifyVpnConnectionAttribute接口时除支持配置必填参数外，还支持配置以下请求参数：

      ClientToken、Name、LocalSubnet、RemoteSubnet、EffectImmediately、IkeConfig、IpsecConfig、HealthCheckConfig、AutoConfigRoute、EnableDpd、EnableNatTraversal、BgpConfig、RemoteCaCertificate。

    • ModifyVpnConnectionAttribute 接口属于异步接口，即系统返回一个请求 ID，但该 IPsec 连接的配置信息未修改成功，系统后台的修改任务仍在进行。您可以调用 DescribeVpnGateway 查询 VPN 网关实例状态，来确定 IPsec 连接的配置信息的修改状态：

      • 当 VPN 网关实例处于 updating 状态时，表示 IPsec 连接的配置信息正在修改中。
      • 当 VPN 网关实例处于 active 状态时，表示 IPsec 连接的配置信息修改成功。

    • ModifyVpnConnectionAttribute 接口不支持在同一 VPN 网关下并发修改 IPsec 连接的配置信息。

    调试

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

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    vpc:ModifyVpnConnectionAttributeupdate
    *VpnConnection
    acs:vpc:{#regionId}:{#accountId}:vpnconnection/{#VpnConnectionId}
      无
    		无

    请求参数

    名称类型必填描述示例值
    RegionIdstring是

    IPsec 连接所在的地域 ID。

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

    		 cn-shanghai
    ClientTokenstring否

    客户端 Token，用于保证请求的幂等性。

    从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。

    说明 若您未指定，则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
    		02fb3da4-130e-11e9-8e44-0016e04115b
    VpnConnectionIdstring是

    IPsec 连接的 ID。

    		vco-bp1bbi27hojx80nck****
    Namestring否

    IPsec 连接的名称。

    长度为 1～100 个字符，不能以http://或https://开头。

    		nametest
    LocalSubnetstring否

    需要和本地数据中心互连的 VPC 侧的网段，用于第二阶段协商。

    多个网段之间用半角逗号（,）分隔，例如：192.168.1.0/24,192.168.2.0/24。

    关于 IPsec 连接路由模式的说明：

    • 如果 LocalSubnet 和 RemoteSubnet 均输入为 0.0.0.0/0，则表示您使用目的路由模式。
    • 如果 LocalSubnet 和 RemoteSubnet 均输入具体的网段，则表示您使用感兴趣流模式。
    		10.1.1.0/24,10.1.2.0/24
    RemoteSubnetstring否

    本地数据中心侧的网段，用于第二阶段协商。

    多个网段之间用半角逗号（,）分隔，例如：192.168.3.0/24,192.168.4.0/24。

    关于 IPsec 连接路由模式的说明：

    • 如果 LocalSubnet 和 RemoteSubnet 均输入为 0.0.0.0/0，则表示您使用目的路由模式。
    • 如果 LocalSubnet 和 RemoteSubnet 均输入具体的网段，则表示您使用感兴趣流模式。
    		10.2.1.0/24,10.2.2.0/24
    EffectImmediatelyboolean否

    选择 IPsec 连接的配置是否立即生效。取值：

    • true：是，配置完成后系统立即进行 IPsec 协议协商。

    • false：否，当有流量进入时系统才进行 IPsec 协议协商。

    		false
    IkeConfigstring否

    修改单隧道模式的 IPsec-VPN 连接时支持配置该参数。

    第一阶段协商的配置信息：

    • IkeConfig.Psk：预共享密钥，用于 VPN 网关与本地数据中心之间的身份认证。

      • 密钥长度为 1~100 个字符，支持数字、大小写英文字母以及右侧字符，不能包含空格。~!`@#$%^&*()_-+={}[]|;:',.<>/?
      • 若您未指定预共享密钥，系统会随机生成一个 16 位的字符串作为预共享密钥。您可以调用 DescribeVpnConnection 接口查询系统自动生成的预共享密钥。
      说明 IPsec 连接侧的预共享密钥需和本地数据中心侧的认证密钥一致，否则本地数据中心和 VPN 网关之间无法建立连接。

    • IkeConfig.IkeVersion：IKE 协议的版本。取值：ikev1 或 ikev2。

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

    • IkeConfig.IkeMode：IKE 版本的协商模式。取值：main 或 aggressive。

      • main：主模式，协商过程安全性高。

      • aggressive：野蛮模式，协商快速且协商成功率高。

    • IkeConfig.IkeEncAlg：第一阶段协商的加密算法。

      取值：aes、aes192、aes256、des 或 3des。

    • IkeConfig.IkeAuthAlg：第一阶段协商的认证算法。

      取值：md5、sha1、sha256、sha384、sha512。

    • IkeConfig.IkePfs：第一阶段协商使用的 Diffie-Hellman 密钥交换算法。取值：group1、group2、group5、group14。

    • IkeConfig.IkeLifetime：第一阶段协商出的 SA 的生存周期。单位：秒。取值范围：0~86400。

    • IkeConfig.LocalId：VPN 网关的标识。长度限制为 100 个字符，不能包含空格。默认值为 VPN 网关的 IP 地址。

    • IkeConfig.RemoteId：用户网关的标识。长度限制为 100 个字符，不能包含空格。默认值为用户网关的 IP 地址。

    		{"Psk":"pgw6dy7d1i8i****","IkeVersion":"ikev1","IkeMode":"main","IkeEncAlg":"aes","IkeAuthAlg":"sha1","IkePfs":"group2","IkeLifetime":86400,"LocalId":"116.64.XX.XX","RemoteId":"139.18.XX.XX"}
    IpsecConfigstring否

    修改单隧道模式的 IPsec-VPN 连接时支持配置该参数。

    第二阶段协商的配置信息：

    • IpsecConfig.IpsecEncAlg：第二阶段协商的加密算法。

      取值：aes、aes192、aes256、des 或 3des。

    • IpsecConfig. IpsecAuthAlg：第二阶段协商的认证算法。

      取值：md5、sha1、sha256、sha384、sha512。

    • IpsecConfig. IpsecPfs：转发所有协议的报文，第一阶段协商使用的 Diffie-Hellman 密钥交换算法。取值：disabled、group1、group2、group5、group14。

    • IpsecConfig. IpsecLifetime：第二阶段协商出的 SA 的生存周期。单位：秒。取值范围：0~86400。

    		{"IpsecEncAlg":"aes","IpsecAuthAlg":"sha1","IpsecPfs":"group2","IpsecLifetime":86400}
    HealthCheckConfigstring否

    修改单隧道模式的 IPsec-VPN 连接时支持配置该参数。

    健康检查配置信息：

    • HealthCheckConfig.enable：是否开启健康检查。取值：true 或 false。

    • HealthCheckConfig.dip：健康检查的目的 IP 地址。

    • HealthCheckConfig.sip：健康检查的源 IP 地址。

    • HealthCheckConfig.interval：健康检查的重试间隔时间，单位：秒。

    • HealthCheckConfig.retry：健康检查的重试发包次数。

    		{"enable":"true","dip":"192.168.1.1","sip":"10.1.1.1","interval":"3","retry":"3"}
    AutoConfigRouteboolean否

    是否自动发布路由。取值：

    • true：自动发布。

    • false：不自动发布。

    		true
    EnableDpdboolean否

    修改单隧道模式的 IPsec-VPN 连接时支持配置该参数。

    是否开启 DPD（对等体存活检测）功能。取值：

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

    • false：不开启 DPD 功能，IPsec 发起端不会发送 DPD 探测报文。

    		true
    EnableNatTraversalboolean否

    修改单隧道模式的 IPsec-VPN 连接时支持配置该参数。

    是否开启 NAT 穿越功能。取值：

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

    • false：不开启 NAT 穿越功能。

    		true
    BgpConfigstring否

    修改单隧道模式的 IPsec-VPN 连接时支持配置该参数。

    BGP 的配置信息：

    • BgpConfig.EnableBgp：是否开启 BGP 功能。取值：true 或 false。

    • BgpConfig.LocalAsn：阿里云侧的自治系统号。自治系统号取值范围：1~4294967295。

      支持按照两段位的格式进行输入，即：前 16 位比特.后 16 位比特。每个段位使用十进制输入。

      例如输入 123.456，则表示自治系统号：123*65536+456=8061384。

    • BgpConfig.TunnelCidr：IPsec 隧道网段。该网段需是一个在 169.254.0.0/16 内的掩码长度为 30 的网段，且不能是 169.254.0.0/30、169.254.1.0/30、169.254.2.0/30、169.254.3.0/30、169.254.4.0/30、169.254.5.0/30、169.254.6.0/30 和 169.254.169.252/30。

      说明 一个 VPN 网关实例下每个 IPsec 连接的 IPsec 隧道网段需保持唯一。

    • LocalBgpIp：阿里云侧的 BGP 地址。该地址为 IPsec 隧道网段内的一个 IP 地址。

    说明
  • 当您的 VPN 网关启用 BGP 动态路由功能时需要配置该参数。
  • 在添加 BGP 配置前，建议您先了解 BGP 动态路由功能的工作机制和使用限制。更多信息，请参见配置 BGP 动态路由 。
  • 建议您使用自治系统号的私有号码与阿里云建立 BGP 连接。自治系统号的私有号码范围请自行查阅文档。
    •
    		{"EnableBgp":"true","LocalAsn":"65530","TunnelCidr":"169.254.11.0/30","LocalBgpIp":"169.254.11.1"}
    RemoteCaCertificatestring否

    修改单隧道模式的 IPsec-VPN 连接时支持配置该参数。

    如果当前 VPN 网关实例为国密型 VPN 网关，您可以修改对端的 CA 证书。

    如果当前 VPN 网关实例为普通型 VPN 网关，不支持配置本参数。

    		-----BEGIN CERTIFICATE----- MIIB7zCCAZW**** -----END CERTIFICATE-----
    TunnelOptionsSpecificationarray<object>否

    修改隧道的配置。

    仅修改双隧道模式的 IPsec-VPN 连接时支持配置 TunnelOptionsSpecification 数组下的参数。您可以同时修改 IPsec-VPN 连接主隧道和备隧道的配置。

    object否

    修改隧道配置。

    TunnelIdstring否

    隧道 ID。

    		tun-opsqc4d97wni27****
    CustomerGatewayIdstring否

    隧道关联的用户网关实例 ID。

    		cgw-1nmwbpgrp7ssqm1yn****
    Rolestring否

    隧道的角色。

    • master：表示当前隧道为主隧道。
    • slave：表示当前隧道为备隧道。
    		master
    EnableDpdboolean否

    是否为隧道开启 DPD（对等体存活检测）功能。取值：

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

    • false：不开启 DPD 功能，IPsec 发起端不会发送 DPD 探测报文。

    		true
    EnableNatTraversalboolean否

    是否为隧道开启 NAT 穿越功能。取值：

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

    • false：不开启 NAT 穿越功能。

    		true
    RemoteCaCertificatestring否

    如果当前 VPN 网关实例为国密型 VPN 网关，您可以隧道修改对端的 CA 证书。

    如果当前 VPN 网关实例为普通型 VPN 网关，不支持配置本参数。

    		-----BEGIN CERTIFICATE----- MIIB7zCCAZW**** -----END CERTIFICATE-----
    TunnelBgpConfigobject否

    修改隧道的 BGP 配置。

    LocalAsnlong否

    隧道本端（阿里云侧）的自治系统号。自治系统号取值范围：1~4294967295。默认值：45104。

    说明
  • 当您为 IPsec 连接开启 BGP 功能后（即指定 EnableTunnelsBgp 参数的值为 true）支持配置或修改本参数。
  • 在添加 BGP 配置前，建议您先了解 BGP 动态路由功能的工作机制和使用限制。更多信息，请参见配置 BGP 动态路由。
  • 建议您使用自治系统号的私有号码与阿里云建立 BGP 连接。自治系统号的私有号码范围请自行查阅文档。
    •
    		65530
    LocalBgpIpstring否

    隧道本端（阿里云侧）的 BGP 地址。该地址为 BGP 网段内的一个 IP 地址。

    		169.254.10.1
    TunnelCidrstring否

    隧道的 BGP 网段。

    该网段需是一个在 169.254.0.0/16 内的掩码长度为 30 的网段，且不能是 169.254.0.0/30、169.254.1.0/30、169.254.2.0/30、169.254.3.0/30、169.254.4.0/30、169.254.5.0/30、169.254.6.0/30 和 169.254.169.252/30。

    说明 在一个 VPN 网关实例下，每个隧道的 BGP 网段需保持唯一。
    		169.254.10.0/30
    TunnelIkeConfigobject否

    第一阶段协商的配置信息。

    IkeAuthAlgstring否

    第一阶段协商的认证算法。

    取值：md5、sha1、sha256、sha384、sha512。

    		md5
    IkeEncAlgstring否

    第一阶段协商的加密算法。

    取值：aes、aes192、aes256、des 或 3des。

    		aes
    IkeLifetimelong否

    第一阶段协商出的 SA 的生存周期。单位：秒。取值范围：0~86400。

    		86400
    IkeModestring否

    IKE 版本的协商模式。取值：

    • main：主模式，协商过程安全性高。
    • aggressive：野蛮模式，协商快速且协商成功率高。
    		main
    IkePfsstring否

    第一阶段协商使用的 Diffie-Hellman 密钥交换算法。取值：group1、group2、group5、group14。

    		group2
    IkeVersionstring否

    IKE 协议的版本。取值：ikev1 或 ikev2。

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

    		ikev1
    LocalIdstring否

    隧道本端（阿里云侧）的标识，用于第一阶段的协商。长度限制为 100 个字符，不能包含空格。默认值为隧道的 IP 地址。

    LocalId 支持 FQDN 格式，如果您使用 FQDN 格式，协商模式建议选择为 aggressive（野蛮模式）。

    		47.21.XX.XX
    Pskstring否

    预共享密钥，用于隧道与隧道对端之间的身份认证。

    • 密钥长度为 1~100 个字符，支持数字、大小写英文字母以及右侧字符，不能包含空格。~!\`@#$%^&*()_-+={}[]|;:',.<>/?

    • 若您未指定预共享密钥，系统会随机生成一个 16 位的字符串作为预共享密钥。您可以调用 DescribeVpnConnection 接口查询系统自动生成的预共享密钥。

    说明 隧道及隧道对端的预共享密钥需一致，否则系统无法正常建立隧道。
    		123456****
    RemoteIdstring否

    隧道对端的标识，用于第一阶段的协商。长度限制为 100 个字符，不能包含空格。默认值为隧道关联的用户网关的 IP 地址。

    RemoteId 支持 FQDN 格式，如果您使用 FQDN 格式，协商模式建议选择为 aggressive（野蛮模式）。

    		47.42.XX.XX
    TunnelIpsecConfigobject否

    第二阶段协商的配置信息。

    IpsecAuthAlgstring否

    第二阶段协商的认证算法。

    取值：md5、sha1、sha256、sha384、sha512。

    		md5
    IpsecEncAlgstring否

    第二阶段协商的加密算法。

    取值：aes、aes192、aes256、des 或 3des。

    		aes
    IpsecLifetimeinteger否

    第二阶段协商出的 SA 的生存周期。单位：秒。取值范围：0~86400。

    		86400
    IpsecPfsstring否

    第二阶段协商使用的 Diffie-Hellman 密钥交换算法。

    取值：disabled、group1、group2、group5、group14。

    		group2
    EnableTunnelsBgpboolean否

    修改双隧道模式的 IPsec-VPN 连接时支持配置该参数。

    是否为隧道开启 BGP 功能。取值：true 或 false。

    		true

    返回参数

    名称类型描述示例值
    object

    返回结果。

    EnableNatTraversalboolean

    IPsec 连接是否已开启 NAT 穿越功能。取值：

    • false：未开启。

    • true：已开启。

    仅单隧道模式的 IPsec-VPN 连接会返回该参数。

    		true
    CreateTimelong

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

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

    		1492753817000
    EffectImmediatelyboolean

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

    • true：是，配置完成后系统立即进行 IPsec 协议协商。

    • false：否，当有流量进入时系统才进行 IPsec 协议协商。

    		false
    VpnGatewayIdstring

    VPN 网关实例的 ID。

    		vpn-bp1q8bgx4xnkm2ogj****
    LocalSubnetstring

    VPC 侧的网段。

    		10.1.1.0/24,10.1.2.0/24
    RequestIdstring

    请求 ID。

    		7DB79D0C-5F27-4AB5-995B-79BE55102F90
    VpnConnectionIdstring

    IPsec 连接的 ID。

    		vco-bp1bbi27hojx80nck****
    Descriptionstring

    IPsec 连接的描述信息。

    		description
    RemoteSubnetstring

    本地数据中心侧的网段。

    		10.2.1.0/24,10.2.2.0/24
    CustomerGatewayIdstring

    IPsec 连接关联的用户网关 ID。

    仅单隧道模式的 IPsec-VPN 连接会返回该参数。

    		cgw-p0w2jemrcj5u61un8****
    Namestring

    IPsec 连接的名称。

    		nametest
    EnableDpdboolean

    IPsec 连接是否已开启 DPD（对等体存活检测）功能。

    • false：未开启。

    • true：已开启。

    仅单隧道模式的 IPsec-VPN 连接会返回该参数。

    		true
    IkeConfigobject

    第一阶段协商的配置。

    仅单隧道模式的 IPsec-VPN 连接会返回 IkeConfig 数组下的参数。

    RemoteIdstring

    本地数据中心侧的标识。支持 FQDN 和 IP 格式，默认为当前选取的用户网关的 IP 地址。

    		139.18.XX.XX
    IkeLifetimelong

    IKE 阶段生存时间。单位：秒。

    		86400
    IkeEncAlgstring

    IKE 阶段加密算法。

    		aes
    LocalIdstring

    VPC 侧的标识。支持 FQDN 和 IP 格式，默认为当前选取的 VPN 网关的 IP 地址。

    		116.64.XX.XX
    IkeModestring

    IKE 协商模式。

    • main：主模式，协商过程安全性高。
    • aggressive：野蛮模式，协商快速且协商成功率高。
    		main
    IkeVersionstring

    IKE 协议版本。

    • ikev1
    • ikev2

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

    		ikev1
    IkePfsstring

    IKE 阶段 DH 分组。

    		group2
    Pskstring

    预共享密钥。

    		pgw6dy7d1i8i****
    IkeAuthAlgstring

    IKE 阶段认证算法。

    		sha1
    IpsecConfigobject

    第二阶段协商的配置。

    仅单隧道模式的 IPsec-VPN 连接会返回 IpsecConfig 数组下的参数。

    IpsecAuthAlgstring

    IPsec 阶段认证算法。

    		sha1
    IpsecLifetimelong

    IPsec 阶段生存时间。单位：秒。

    		86400
    IpsecEncAlgstring

    IPsec 阶段加密算法。

    		aes
    IpsecPfsstring

    IPsec 阶段 DH 分组。

    		group2
    VcoHealthCheckobject

    健康检查配置。

    仅单隧道模式的 IPsec-VPN 连接会返回 VcoHealthCheck 数组下的参数。

    Dipstring

    目标 IP。

    		192.168.1.1
    Intervalinteger

    健康检查的重试间隔时间，单位：秒。

    		3
    Retryinteger

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

    		3
    Sipstring

    源 IP。

    		10.1.1.1
    Enablestring

    IPsec 连接是否已开启健康检查功能。

    • true：已开启。

    • false：未开启。

    		true
    VpnBgpConfigobject

    BGP 配置信息。

    仅单隧道模式的 IPsec-VPN 连接会返回 VpnBgpConfig 数组下的参数。

    Statusstring

    BGP 的协商状态。

    • success：正常。

    • false：异常。

    		success
    PeerBgpIpstring

    本地 IDC 侧的 BGP 地址。

    		169.254.11.2
    TunnelCidrstring

    IPsec 连接的 BGP 网段。

    		169.254.11.0/30
    EnableBgpstring

    BGP 的开启状态。

    • true：已开启。

    • false：未开启。

    		true
    LocalBgpIpstring

    阿里云侧的 BGP 地址。

    		169.254.11.1
    PeerAsninteger

    本地数据中心侧的自治系统号。

    		65531
    LocalAsninteger

    阿里云侧的自治系统号。

    		65530
    TunnelOptionsSpecificationarray<object>

    IPsec 连接的隧道配置信息。

    仅双隧道模式的 IPsec-VPN 连接会返回 TunnelOptionsSpecification 数组下的参数。

    TunnelOptionsobject

    隧道的配置信息。

    CustomerGatewayIdstring

    隧道关联的用户网关 ID。

    		cgw-p0wy363lucf1uyae8****
    EnableDpdboolean

    隧道是否已开启 DPD（对等体存活检测）功能。

    • false：未开启。
    • true：已开启。
    		true
    EnableNatTraversalboolean

    隧道是否已开启 NAT 穿越功能。

    • false：未开启。
    • true：已开启。
    		true
    InternetIpstring

    隧道阿里云侧网关 IP 地址。

    		47.21.XX.XX
    RemoteCaCertificatestring

    隧道对端的 CA 证书。

    仅 VPN 网关实例的类型为国密型时才会返回当前参数。

    		-----BEGIN CERTIFICATE----- MIIB7zCCAZW**** -----END CERTIFICATE-----
    Rolestring

    隧道的角色。

    • master：表示当前隧道为主隧道。
    • slave：表示当前隧道为备隧道。
    		master
    Statestring

    隧道的状态。

    • active：状态正常。
    • updating：更新中。
    • deleting：删除中。
    		active
    TunnelBgpConfigobject

    隧道的 BGP 配置信息。

    LocalAsnlong

    隧道本端（阿里云侧）的自治系统号。

    		65530
    LocalBgpIpstring

    隧道本端（阿里云侧）的 BGP 地址。

    		169.254.10.1
    PeerAsnlong

    隧道对端的自治系统号。

    		65531
    PeerBgpIpstring

    隧道对端的 BGP 地址。

    		169.254.10.2
    TunnelCidrstring

    隧道的 BGP 网段。

    		169.254.10.0/30
    TunnelIdstring

    隧道 ID。

    		tun-opsqc4d97wni27****
    TunnelIkeConfigobject

    第一阶段协商的配置。

    IkeAuthAlgstring

    IKE 阶段认证算法。

    		sha1
    IkeEncAlgstring

    IKE 阶段加密算法。

    		aes
    IkeLifetimelong

    IKE 阶段生存时间。单位：秒。

    		86400
    IkeModestring

    IKE 协商模式。

    • main：主模式，协商过程安全性高。
    • aggressive：野蛮模式，协商快速且协商成功率高。
    		main
    IkePfsstring

    IKE 阶段 DH 分组。

    		group2
    IkeVersionstring

    IKE 协议版本。

    		ikev1
    LocalIdstring

    隧道本端（阿里云侧）的标识。

    		47.21.XX.XX
    Pskstring

    预共享密钥。

    		123456****
    RemoteIdstring

    隧道对端的标识。

    		47.42.XX.XX
    TunnelIpsecConfigobject

    第二阶段协商的配置。

    IpsecAuthAlgstring

    IPsec 阶段认证算法。

    		sha1
    IpsecEncAlgstring

    IPsec 阶段加密算法。

    		aes
    IpsecLifetimelong

    IPsec 阶段生存时间。单位：秒。

    		86400
    IpsecPfsstring

    IPsec 阶段 DH 分组。

    		group2
    ZoneNostring

    隧道部署的可用区。

    		ap-southeast-5a
    EnableTunnelsBgpboolean

    隧道 BGP 的开启状态。

    • true：已开启。
    • false：未开启。

    仅双隧道模式的 IPsec-VPN 连接会返回该参数。

    		true
    ResourceGroupIdstring

    IPsec 连接所属的资源组 ID。

    IPsec 连接与其关联的 VPN 网关实例的资源组相同。您可以调用 ListResourceGroups 接口查询资源组信息。

    		rg-acfmzs372yg****

    示例

    正常返回示例

    JSON格式

    {
  "EnableNatTraversal": true,
  "CreateTime": 1492753817000,
  "EffectImmediately": false,
  "VpnGatewayId": "vpn-bp1q8bgx4xnkm2ogj****",
  "LocalSubnet": "10.1.1.0/24,10.1.2.0/24",
  "RequestId": "7DB79D0C-5F27-4AB5-995B-79BE55102F90",
  "VpnConnectionId": "vco-bp1bbi27hojx80nck****",
  "Description": "description",
  "RemoteSubnet": "10.2.1.0/24,10.2.2.0/24",
  "CustomerGatewayId": "cgw-p0w2jemrcj5u61un8****",
  "Name": "nametest",
  "EnableDpd": true,
  "IkeConfig": {
    "RemoteId": "139.18.XX.XX",
    "IkeLifetime": 86400,
    "IkeEncAlg": "aes",
    "LocalId": "116.64.XX.XX",
    "IkeMode": "main",
    "IkeVersion": "ikev1",
    "IkePfs": "group2",
    "Psk": "pgw6dy7d1i8i****",
    "IkeAuthAlg": "sha1"
  },
  "IpsecConfig": {
    "IpsecAuthAlg": "sha1",
    "IpsecLifetime": 86400,
    "IpsecEncAlg": "aes",
    "IpsecPfs": "group2"
  },
  "VcoHealthCheck": {
    "Dip": "192.168.1.1",
    "Interval": 3,
    "Retry": 3,
    "Sip": "10.1.1.1",
    "Enable": "true"
  },
  "VpnBgpConfig": {
    "Status": "success",
    "PeerBgpIp": "169.254.11.2",
    "TunnelCidr": "169.254.11.0/30",
    "EnableBgp": "true",
    "LocalBgpIp": "169.254.11.1",
    "PeerAsn": 65531,
    "LocalAsn": 65530
  },
  "TunnelOptionsSpecification": {
    "TunnelOptions": [
      {
        "CustomerGatewayId": "cgw-p0wy363lucf1uyae8****",
        "EnableDpd": true,
        "EnableNatTraversal": true,
        "InternetIp": "47.21.XX.XX",
        "RemoteCaCertificate": "-----BEGIN CERTIFICATE----- MIIB7zCCAZW**** -----END CERTIFICATE-----",
        "Role": "master",
        "State": "active",
        "TunnelBgpConfig": {
          "LocalAsn": 65530,
          "LocalBgpIp": "169.254.10.1",
          "PeerAsn": 65531,
          "PeerBgpIp": "169.254.10.2",
          "TunnelCidr": "169.254.10.0/30"
        },
        "TunnelId": "tun-opsqc4d97wni27****",
        "TunnelIkeConfig": {
          "IkeAuthAlg": "sha1",
          "IkeEncAlg": "aes",
          "IkeLifetime": 86400,
          "IkeMode": "main",
          "IkePfs": "group2",
          "IkeVersion": "ikev1",
          "LocalId": "47.21.XX.XX",
          "Psk": "123456****",
          "RemoteId": "47.42.XX.XX"
        },
        "TunnelIpsecConfig": {
          "IpsecAuthAlg": "sha1",
          "IpsecEncAlg": "aes",
          "IpsecLifetime": 86400,
          "IpsecPfs": "group2"
        },
        "ZoneNo": "ap-southeast-5a"
      }
    ]
  },
  "EnableTunnelsBgp": true,
  "ResourceGroupId": "rg-acfmzs372yg****"
}

    错误码

    HTTP status code错误码错误信息描述
    400VpnGateway.ConfiguringThe specified service is configuring.服务正在配置中，请您稍后再试。
    400VpnGateway.FinancialLockedThe specified service is financial locked.该服务已欠费，请您先充值再操作。
    400InvalidNameThe name is not valid该名称格式不合法。
    400VpnRouteEntry.AlreadyExistsThe specified route entry is already exist.该路由已存在。
    400VpnRouteEntry.ConflictThe specified route entry has conflict.路由条目存在冲突。
    400NotSupportVpnConnectionParameter.IpsecPfsThe specified vpn connection ipsec Ipsec Pfs is not support.IPsec连接中指定的Pfs参数不支持
    400NotSupportVpnConnectionParameter.IpsecAuthAlgThe specified vpn connection ipsec Auth Alg is not support.IPsec连接中指定的认证算法不支持
    400VpnRouteEntry.ConflictSSLThe specified route entry has conflict with SSL client.路由条目与SSL客户端冲突。
    400VpnRouteEntry.BackupRouteValidate backup route entry failed.主备路由条目校验失败。
    400VpnRouteEntry.InvalidWeightInvalid route entry weight value.路由权重值不合法
    400QuotaExceeded.PBRThe policy-based routes has reached the upper limit.创建的策略路由条数已达上限
    400OperationUnsupported.SetDPDCurrent version of the VPN does not support setting DPD.当前VPN网关版本不支持DPD功能。
    400OperationUnsupported.SetNatTraversalCurrent version of the VPN does not support setting NAT traversal.当前VPN网关版本不支持NAT穿越功能。
    400QuotaExceeded.PolicyBasedRouteThe maximum number of policy-based routes is exceeded. Existing routes: %s. Routes to be created: %s. Maximum routes: %s.策略路由条数已达上限，当前已有%s条，本次将创建%s条，上限为%s条。
    400MissingParameter.TunnelCidrThe parameter TunnelCidr is mandatory when BGP is enabled.开启BGP时，隧道CIDR参数是必填项
    400OperationUnsupported.EnableBgpCurrent version of the VPN does not support enable BGP.当前版本的VPN不支持开启BGP
    400MissingParam.CustomerGatewayAsnAsn of customer gateway is mandatory when BGP is enabled.开启BGP时，客户网关的自治系统号不可以为空。
    400IllegalParam.LocalAsnThe specified LocalAsn is invalid.本端自治系统号不合法。
    400IllegalParam.BgpConfigThe specified BgpConfig is invalid.指定的BGP配置不合法
    400IllegalParam.EnableBgpVPN connection must enable BGP when VPN gateway has enabled BGP.当 VPN 网关启用 BGP 时，VPN 连接必须启用 BGP。
    400IllegalParam.TunnelCidrThe specified TunnelCidr is invalid.参数TunnelCidr不合法。
    400InvalidLocalBgpIp.MalformedThe specified LocalBgpIp is malformed.指定的本端BGP的IP异常
    400IllegalParam.LocalBgpIpThe specified LocalBgpIp is invalid.本端BGP地址不合法。
    400IllegalParam.LocalSubnetThe specified "LocalSubnet" (%s) is invalid.本端网段(%s)不合法。
    400IllegalParam.RemoteSubnetThe specified "RemoteSubnet" (%s) is invalid.对端网段(%s)不合法。
    400OperationFailed.CenLevelNotSupportWhen the VPC to which the VPN gateway belongs is attached to a FULL-mode CEN, the VPN gateway cannot enable BGP.当VPN网关所属VPC加入到的云企业网且开启了路由同步时，VPN网关不能开启BGP。
    400InvalidTunnelCidr.MalformedThe specified TunnelCidr is malformed.指定的隧道CIDR异常
    400CustomerGateway.ConflictRouteEntryThe specified customer gateway has conflict with route entry.当前用户网关和路由存在冲突。
    400VpnTask.CONFLICTVpn task has conflict.Vpn操作存在冲突，请稍后重试。
    400OperationFailed.RouteConflictWithIPsecServerOperation failed because the route to create conflicts with the client IP pool of the IPsec server.路由的目标网段和IPsec服务端的客户端网段冲突。
    400IllegalParam.TunnelIdThe specified TunnelId is invalid.TunnelId参数非法。
    400IllegalParam.RoleThe specified Role is invalid.Role参数不合法。
    400VpnConnectionParamInvalid.SameVpnAndCgwDifferentIkeConfigsIPSec connections associated with the same user gateway and VPN gateway should have the same pre-shared key and IKE configuration.检测到多个IPsec连接关联了相同的VPN网关和用户网关，多个IPsec连接的预共享密钥和IKE阶段的配置参数需保持相同。
    400VpnConnectionParamInvalid.SameVpnAndCgwTrafficSelectorOverlapTraffic selectors of IPSec connections associated with the same user gateway and VPN gateway should not overlap.检测到多个IPsec连接关联了相同的VPN网关和用户网关，多个IPsec连接的感兴趣流网段不能重叠。
    400ModifyIkeV1WithMultiRoutes.InvalidFailed to modify VPN connection parameters. Multi-network is configured while using IkeV1 protocol.修改VPN连接参数失败，在使用IkeV1协议的同时配置了多网端。
    403Forbbiden.SubUserUser not authorized to operate on the specified resource as your account is created by another user.您没有权限操作该资源，请您申请操作权限后再试。
    403ForbiddenUser not authorized to operate on the specified resource.您没有权限操作指定资源，请申请权限后再操作。
    404InvalidVpnConnectionInstanceId.NotFoundThe specified vpn connection instance id does not exist.指定的VPN连接不存在，请您检查该VPN连接ID是否正确。
    500OperationFailed.RouteConflictWithIPsecServerOperation failed because the specified route conflicts with IPsec server.路由配置与IPsec服务端冲突。

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

    变更历史

    变更时间变更内容概要操作
    2024-10-24OpenAPI 错误码发生变更查看变更详情
    2024-01-04OpenAPI 描述信息更新、OpenAPI 错误码发生变更查看变更详情
    2023-10-23OpenAPI 错误码发生变更查看变更详情
    2023-10-19OpenAPI 去除了 deprecated 标记、OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
    2023-08-01OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
    2023-06-30OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情