You need to enable JavaScript to run this app.
导航
VPN连接
  • 文档首页
    • /VPN连接/API参考/IPsec连接/ModifyVpnConnectionAttributes
ModifyVpnConnectionAttributes
最近更新时间：2024.09.25 15:57:09首次发布时间：2022.04.28 07:17:15
我的收藏

调用ModifyVpnConnectionAttributes修改IPsec连接的信息，包括名称、描述、本端网段、对端网段、IKE配置和IPsec配置等。

调用说明

2024年09月30日前已创建的TR类型的IPsec连接，如需修改IPsec连接配置开启动态路由传播模式，请提交工单处理。

调试

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

请求参数

名称类型是否必选示例值
描述
ActionString是ModifyVpnConnectionAttributes要执行的操作，取值：ModifyVpnConnectionAttributes
VersionString是2020-04-01API版本信息。
VpnConnectionIdString是vgc-3tehy13n2l4c6c0v****IPsec连接的ID。您可调用DescribeVpnConnections查询IPsec连接的ID信息。

VpnConnectionName

String

否

abc

IPsec连接的名称。

  • 以中文、字母、数字开头，只能包含中文、字母、数字、点号（.）、下划线（_）和短划线（-）。
  • 长度限制为1 ~ 128个字符。
  • 不填保持原有配置。

Description

String

否

This is a sample description

IPsec连接的描述。

  • 以中文、字母、数字开头，只能包含中文、字母、数字、点号（.）、空格（ ）、下划线（_）、中划线（-）、等号（=）、英文逗号（,）、中文逗号（，）、中文句号（。）。
  • 长度限制为0 ~ 255个字符。
  • 不填保持原有配置。

LocalSubnet.N

List of String

否

LocalSubnet.1=10.0.XX.0/24&LocalSubnet.2=10.0.XX.0/24

IPsec连接的本端网段。

  • 参数 - N表示本端网段的序号。
  • 最多支持传入5个网段。
  • 多个网段之间用&分隔。
  • 不填保持原有配置。

RemoteSubnet.N

List of String

否

RemoteSubnet.1=172.16.XX.0/24&RemoteSubnet.2=172.16.XX.0/24

IPsec连接的对端网段。

  • 参数 - N表示对端网段的序号。
  • 最多支持传入5个网段。
  • 多个网段之间用&分隔。
  • 不填保持原有配置。

IkeConfig

List of String

否

IkeConfig.Psk=Test123***&IkeConfig.Version=v1&IkeConfig.Mode=main&IkeConfig.EncAlg=aes&IkeConfig.AuthAlg=sha1&IkeConfig.DhGroup=group2&IkeConfig.Lifetime=86400

IPsec连接的IKE配置信息，不填的参数将保持原有配置。包含如下参数：

说明

若传入的用户网关的IP地址为0.0.0.0，IkeConfig.Version仅可传入ikev1且IkeConfig.Mode仅可传入aggressive。

  • IkeConfig.Psk：预共享密钥，用于第一阶段VPN网关与用户网关之间的身份认证。长度不超过100个字符，只可输入大小写字母、特殊符号~ ` | ! @ # $ % ^ ( ) - _ + = [ ] { } \ , . / : ;以及数字。
  • IkeConfig.Version：IKE密钥交换协议的版本。取值如下
    • ikev1
    • ikev2
  • IkeConfig.Mode：第一阶段的协商模式，仅IkeConfig.Version为ikev1时需传入本参数。取值如下：
    • main
    • aggressive
  • IkeConfig.EncAlg：第一阶段协商的加密算法。取值如下：
    • aes
    • aes192
    • aes256
    • des
    • 3des
    • sm4
  • IkeConfig.AuthAlg：第一阶段的认证算法。取值如下：
    • sha1
    • md5
    • sha256
    • sha384
    • sha512
    • sm3
  • IkeConfig.DhGroup：第一阶段协商使用的DH（Diffie-Hellman）密钥交换算法。取值如下：
    • group1
    • group2
    • group5
    • group14
  • IkeConfig.Lifetime：第一阶段协商的SA的生存时间，超过生存时间后，将重新发起协商。取值范围：900~86400，单位：秒。
  • IkeConfig.LocalId：VPN网关的标识，用于第一阶段的协商，支持IP格式和FQDN( Fully Qualified Domain Name)完全合格域名/全称域名格式。
    • 若您手动设置为FQDN格式，协商模式推荐设置为“aggressive”。
    • 长度不超过100个字符，只可输入大小写字母、特殊符号~ ` | ! @ # $ % ^ ( ) - _ + = [ ] { } \ , . / : ;以及数字。
  • IkeConfig.RemoteId：用户网关的标识，用于第一阶段的协商，支持IP格式和FQDN( Fully Qualified Domain Name)完全合格域名/全称域名格式。
    • 若您手动设置为FQDN格式，协商模式推荐设置为“aggressive”。
    • 长度不超过100个字符，只可输入大小写字母、特殊符号~ ` | ! @ # $ % ^ ( ) - _ + = [ ] { } \ , . / : ;以及数字。

IpsecConfig

List of String

否

IpsecConfig.EncAlg=aes&IpsecConfig. AuthAlg=sha1&IpsecConfig. DhGroup=group2&IpsecConfig.Lifetime=86400

IPsec连接的IPsec配置信息，不填的参数将保持原有配置。包含如下参数：

  • IpsecConfig.EncAlg：第二阶段协商的加密算法。取值如下：
    • aes
    • aes192
    • aes256
    • des
    • 3des
    • sm4
  • IpsecConfig.AuthAlg：第二阶段协商的认证算法。取值如下：
    • sha1
    • md5
    • sha256
    • sha384
    • sha512
    • sm3
  • IpsecConfig.DhGroup：第二阶段使用的DH（Diffie-Hellman）密钥交换算法。取值如下：
    • group1
    • group2
    • group5
    • group14
    • disable（不配置DH算法）

若选择group1、group2、group5、group14，将默认开启PFS（Perfect Forward Secrecy）完美前向保密功能，对应的客户端也需要开启PFS功能。若客户端不支持PFS功能，此处需配置为“disable”。

  • IpsecConfig.Lifetime：第二阶段协商的SA的生存时间，超过生存时间后，将重新发起协商。
    • 取值范围：900~86400
    • 单位：秒。

NatTraversal

Boolean

否

false

是否开启NAT穿越功能。

  • true：开启。
  • false：不开启。
  • 不填保持原有配置。

DpdAction

String

否

clear

DPD功能的状态。

  • none：关闭DPD功能。
  • clear（默认）：开启DPD功能，DPD超时后清除IKE SA。
  • hold：开启DPD功能，DPD超时后保持当前状态，等待新的流量进入后重新建立连接。
  • restart：开启DPD功能，DPD超时后立即重连。

NegotiateInstantly

Boolean

否

true

是否立即发起协商模式。

说明

若IPsec连接关联的用户网关IP地址为0.0.0.0，此处仅可传入false。

  • true：IPsec连接配置完成后系统立即主动发起协商。
  • false：IPsec连接配置完成后系统不主动发起协商，当有流量通过时被动发起协商。
  • 不填保持原有配置。

LogEnabled

Boolean

否

false

是否启用连接日志。启用连接日之后，您可查看、下载IPsec连接日志，并通过日志信息自行排查IPsec连接的故障问题。

  • true：启用。
  • false：不启用。
  • 不填保持原有配置。

说明

启用连接日志前请先确认当前账号已开通日志服务和对象存储服务，并已为VPN连接服务授权跨服务访问日志服务。

Spec

String

否

default

IPsec连接实例规格，仅关联TR实例的IPsec生效，关联VPN网关实例的IPsec无效。不填保持默认配置。

  • default：默认规格。
  • large：1G规格。

说明

1G规格当前为邀测阶段，仅开启后可使用，如需试用请联系客户经理开通。未开通1G规格，此处请不要传入large。

BgpConfig.EnableBgp

Bool

否

True

是否开启动态路由传播功能。

  • false（默认）：否，使用静态路由模式。
  • true：是，使用BGP路由模式。
  • 不填保持原有配置。

说明

BGP功能当前为邀测阶段，仅开启后可使用BGP功能，如需试用请联系客户经理开通。未开启BGP功能，此处请不要传入true。

BgpConfig.TunnelCidr

String

否

169.254.XX.XX/30

隧道网段，是BGP 会话本端IP和对端IP所在的 CIDR 地址段。

  • 该地址段需要在 169.254.0.0/16 网段内、掩码长度为 /30 的网段，且不可在169.254.255.0/24网段内。
  • 如果BgpConfig.EnableBgp传入值为true，此参数需必须填写。
  • 不填保持原有配置。

BgpConfig.LocalBgpIp

String

否

169.254.XX.XX

本端隧道IP，是配置在VPN网关上的BGP地址

  • 默认为BgpConfig.TunnelCidr的第一个主机地址。
  • 该地址必须为 IPsec 隧道网段内的一个 IP 地址。
  • 如果BgpConfig.EnableBgp传入值为true，此参数需必须填写。
  • 不填保持原有配置。
CustomerGatewayIdString否cgw-3tehy13n2l4c6c0v****IPsec连接关联的用户网关的ID。您可调用DescribeCustomerGateways查询用户网关的ID信息，不填保持原有配置。

返回数据

名称类型
示例值
描述
RequestIdString202203211611080102121461940900****请求ID。
OrderIdStringOrder7078570823273845036订单ID。

请求示例

GET /?Action=ModifyVpnConnectionAttributes&Version=2020-04-01&VpnConnectionId=vgc-2bzvqi8kerd342dx0eg2f****&IpsecConfig.EncAlg=aes256 HTTP/1.1
Host: open.volcengineapi.com
ServiceName: vpn
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202203211611080102121461940900****",
        "Action": "ModifyVpnConnectionAttributes",
        "Version": "2020-04-01",
        "Service": "vpn",
        "Region": "cn-beijing"
    },
    "Result": {
        "RequestId": "202203211611080102121461940900****",
        "OrderId": "Order7078570823273845036"
    }
}

错误码

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

HttpCode错误码错误信息描述
400InvalidName.MalformedThe specified name is malformed.Ensure the maximum length of name is 128.指定的名称格式不合法。名称长度不能超过128个字符。
400InvalidName.MalformedThe specified name is malformed.指定的名称格式不合法。请修复名称格式后重试。
400InvalidDescription.MalformedThe specified description is malformed.Ensure the maximum length of description is 255.指定的描述格式不合法。描述长度不能超过255个字符。
400InvalidDescription.MalformedThe specified description is malformed.指定的描述格式不合法。请修复描述格式后重试。
400InvalidVpnConnectionLocalSubnet.MalformedThe specified LocalSubnet is malformed.指定的本端网段不合法。
400InvalidVpnConnectionRemoteSubnet.MalformedThe specified RemoteSubnet is malformed.指定的对端网段不合法。
400InvalidVpnConnectionIKEPsk.MalformedThe specified IKE Psk is malformed. Ensure the maximum length of IKE Psk is 100.指定的IKE Psk格式不合法。IKE Psk长度不能超过100个字符。
400InvalidVpnConnectionIKEPsk.MalformedThe specified IKE Psk is malformed.指定的IKE Psk不合法。
400InvalidVpnConnectionIKEAuthElg.MalformedThe specified IKE AuthAlg is malformed.指定的IKE AuthAlg不合法。
400InvalidVpnConnectionIKEEncElg.MalformedThe specified IKE EncAlg is malformed.指定的IKE EncAlg不合法。
400InvalidVpnConnectionIKEDhGroup.MalformedThe specified IKE DhGroup is malformed.指定的IKE DhGroup不合法。
400InvalidVpnConnectionIKEMode.MalformedThe specified IKE Mode is malformed.指定的IKE Mode不合法。
400InvalidVpnConnectionIKEVersion.MalformedThe specified IKE Version is malformed.指定的IKE Version不合法。
400InvalidVpnConnectionIKELocalID.MalformedThe specified IKE LocalId is malformed. Ensure the maximum length of IKE LocalId is 100.指定的IKE LocalId格式不合法。IKE LocalId长度不能超过100个字符。
400InvalidVpnConnectionIKELocalID.MalformedThe specified IKE LocalId is malformed.指定的IKE LocalId不合法。
400InvalidVpnConnectionIKERemoteID.MalformedThe specified IKE RemoteId is malformed. Ensure the maximum length of IKE RemoteId is 100.指定的IKE RemoteId格式不合法。IKE RemoteId长度不能超过100个字符。
400InvalidVpnConnectionIKERemoteID.MalformedThe specified IKE RemoteId is malformed.指定的IKE RemoteId不合法。
400InvalidVpnConnectionIKELifetime.MalformedThe specified IKE Lifetime is malformed.指定的IKE Lifetime不合法。
400InvalidVpnConnectionIPSecAuthElg.MalformedThe specified IPSec AuthAlg is malformed.指定的IPSec AuthAlg不合法。
400InvalidVpnConnectionIPSecEncElg.MalformedThe specified IPSec EncAlg is malformed.指定的IPSec EncAlg不合法。
400InvalidVpnConnectionIPSecDhGroup.MalformedThe specified IPSec DhGroup is malformed.指定的IPSec DhGroup不合法。
400InvalidVpnConnectionIPSecLifetime.MalformedThe specified IPSec Lifetime is malformed.指定的IPSec Lifetime不合法。
400QuotaExceeded.LocCIDREachVpnConYou've reached the limit on the number of local subnet per IPSec connection that you can create.已达到每个IPSec连接可创建的本端网段数量上限。
400QuotaExceeded.RemCIDREachVpnConYou've reached the limit on the number of remote subnet per IPSec connection that you can create.已达到每个IPSec连接可创建的对端网段数量上限。
400InvalidVpnConnectionDpdAction.MalformedThe specified DpdAction is malformed.指定的DpdAction不合法。
400InvalidVpnGateway.FirmwareNotSupportedThe specified features aren't supported by the VPN gateway, please upgrade your VPN gateway.VPN网关不支持所选择的功能，请升级您的VPN网关。
400IncorrectVpnConnectionAttachStatusThe operation is not supported by the current IPSec connection attach status.当前操作不支持，请稍后重试。
400IncorrectVpnConnectionStatusThe operation is not supported by the current vpn connection.当前操作不支持，请稍后重试。
400InvalidVpnConnectionLocalSubnet.ConflictThe specified LocalSubnet conflicts with that of another subnet.指定的本端网段与其他网段存在冲突。
400InvalidVpnConnectionRemoteSubnet.ConflictThe specified RemoteSubnet conflicts with that of another subnet.指定的对端网段与其他网段存在冲突。
400InvalidVpnConnectionRemoteId.ConflictThe specified IKE RemoteId conflicts with that of another IPSec connection in the specified VPN gateway.指定的IKE RemoteId与本网关下其他IPSec连接存在冲突。
400InvalidVpnConnection.LogNotSupportedIPSec connection log is not supported in this region.当前地域不支持IPSec连接日志功能。
400LimitExceeded.TLSProjectYou've reached the limit on the number of TLS project per region that you can create.已达到当前账户在单一地域下可创建的TLS日志项目数量上限。
400InsufficientResource.VpnConnectionThe specified region does not have enough resources for IPSec connection.IPSec连接可用资源不足。
400OrderErrorFailed to create an order in one step.创建订单并支付失败。
400UnsupportedOperationThe request on the specified instance is denied due to the account balance and available vouchers are less than 100 yuan in total.因账户余额及可用代金券共不足100元，对于该实例的操作请求被拒绝。
400UnsupportedOperationThe request on the specified instance is denied due to the account in arrears status.因账户处于欠费状态，对于该实例的操作请求被拒绝。
400InvalidVpnConnectionBgpLocalIp.MalformedThe BGP local IP is invalid; it should be within BGP tunnel CIDR and must be a host IP.指定的BGP本端地址不合法。
400InvalidVpnConnectionBgpTunnelCidr.MalformedThe BGP tunnel CIDR is invalid.指定的BGP隧道地址不合法。
400InvalidCustomerGateWay.ASNNotConfiguredThe specified Customer gateway does not have an ASN.指定的用户网关未配置ASN，无法使用BGP功能。
400InvalidCustomerGateway.InvalidStatusThe specified customer gateway is not in the correct status for the request.指定的用户网关所处的状态无法响应该请求。
400InvalidVpnConnection.MoidfyCustomerGatewayNotSupportThe specified VPN connection does not support modifying the customer gateway.指定的VPN连接不支持修改用户网关。
400InvalidVpnConnectionBgpTunnelCidr.ConflictThe specified BGP tunnel CIDR has conflicts.指定的BGP隧道地址存在冲突。
400InvalidVpnGateway.ASNNotConfiguredThe specified VPN gateway does not have an ASN.指定的VPN网关未配置ASN，无法使用BGP功能。
400InvalidVpnGateway.CustomerGateWayASNDuplicatedThe VPN gateway ASN is the same as the customer gateway ASN.VPN网关的ASN与用户网关的ASN一致，无法使用BGP功能。
400InvalidVpnGateway.InvalidStatusThe specified VPN gateway is not in the correct status for the request.指定的VPN网关所处的状态无法响应该请求。
403InvalidVpn.ServiceRoleNotAuthorizedThe service role for VPN has not been authorized.当前账号尚未授权VPN的服务角色。
403InvalidVpnConnection.TlsAccessDeniedTLS service access denied.当前账号未开通日志服务。
403InvalidVpnConnection.TlsNotSupportTLS is not supported in this region.当前账号在此地域不支持TLS服务。
403Forbidden.VpnConnectionBlockedThe specified TR IPsec is blocked.当前TR IPsec封禁中，禁止操作。
403Forbidden.VpnGatewayBlockedThe specified VPN gateway is blocked.当前VPN网关封禁中，禁止操作。
403Forbidden.VpnBgpPermissionNotGrantedThe specified account is not granted VPN BGP permission.当前账号未开通VPN支持BGP权限。
404InvalidVpnConnection.NotFoundThe specified IPSec connection does not exist.指定的IPSec连接不存在。
412InvalidVpnGateway.ExpiredThe specified VPN gateway has expired.指定的VPN网关已过期。
412InvalidVpnConnection.AccountInArrearsThe specified IPSec connection has been shut down due to the account in arrears status.指定的IPSec连接已欠费关停。