调用UpdateIpsecServer接口修改IPsec服务端的配置。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String UpdateIpsecServer

系统规定参数。取值:UpdateIpsecServer

RegionId String cn-shanghai

IPsec服务端所属地域ID。

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

IpsecServerId String iss-bp1bo3xuvcxo7ixll****

IPsec服务端ID。

LocalSubnet String 192.168.0.0/24,172.17.0.0/16

本端网段,指需要和客户端网段互连的VPC侧的网段。

多个网段之间用半角逗号(,)分隔,例如:192.168.1.0/24,192.168.2.0/24。

ClientIpPool String 10.0.0.0/24

客户端网段,指给客户端虚拟网卡分配访问地址的网段。

说明 客户端网段不能和VPC侧网段冲突。
IpsecServerName String test

IPsec服务端名称。

名称长度为2~128个字符,以大小写字母或中文开始,可包含数字、短划线(-)和下划线(_)。

EffectImmediately Boolean false

是否删除当前已协商成功的IPsec隧道并重新发起协商。取值:

  • true:配置完成后立即进行协商。
  • false(默认值):当有流量进入时进行协商。
IkeConfig String {"IkeVersion":"ikev2","IkeMode":"main","IkeEncAlg":"aes","IkeAuthAlg":"sha1","IkePfs":"group2","IkeLifetime":86400}

第一阶段协商参数配置。取值:

  • IkeVersion:IKE协议的版本。取值:ikev1ikev2,默认值:ikev2
  • IkeMode:IKE版本的协商模式。默认值:main
  • IkeEncAlg:第一阶段协商的加密算法。默认值:aes
  • IkeAuthAlg:第一阶段协商的认证算法。默认值:sha1
  • IkePfs:第一阶段协商使用的Diffie-Hellman密钥交换算法。默认值:group2
  • IkeLifetime:第一阶段协商出的SA的生存周期。单位:秒,取值范围:0~86400,默认值:86400
  • LocalId:IPsec服务端标识。支持FQDN和IP地址格式,默认值为VPN网关公网IP地址。
  • RemoteId:对端标识。支持FQDN和IP地址格式,默认值为空。
IpsecConfig String {"IpsecEncAlg":"aes","IpsecAuthAlg":"sha1","IpsecPfs":"group2","IpsecLifetime":86400}

第二阶段协商参数配置。取值:

  • IpsecEncAlg:第二阶段协商的加密算法。默认值:aes
  • IpsecAuthAlg:第二阶段协商的认证算法。默认值:sha1
  • IpsecPfs:转发所有协议的报文。第二阶段协商使用的Diffie-Hellman密钥交换算法。默认值:group2
  • IpsecLifetime:第二阶段协商出的SA的生存周期。单位:秒,取值范围:0~86400,默认值:86400
PskEnabled Boolean true

是否开启预共享密钥认证方式。取值:true,表示开启预共享密钥认证方式。

Psk String Cfd123****

预共享密钥。

用于IPsec服务端与客户端之间的身份认证。密钥长度为1~100个字符。

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

说明 IPsec服务端的预共享密钥需和客户端的认证密钥一致,否则IPsec服务端和客户端之间无法建立连接。
ClientToken String e4567-e89b-12d3-a456-42665544****

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

由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。

说明 若您未指定,则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。
DryRun String false

是否只预检此次请求,取值:

  • true:只预检此次请求,不会更改IPsec服务端配置。检查项包括是否填写了必需参数、请求格式、业务限制等。如果检查不通过,则返回对应错误信息。如果检查通过,则返回DryRunOperation
  • false(默认值):发送正常请求,通过检查后直接更改IPsec服务端配置。

返回数据

名称 类型 示例值 描述
RequestId String B61C08E5-403A-46A2-96C1-F7B1216DB10C

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=UpdateIpsecServer
&RegionId=cn-shanghai
&IpsecServerId=iss-bp1bo3xuvcxo7ixll****
&LocalSubnet=192.168.0.0/24,172.17.0.0/16
&ClientIpPool=10.0.0.0/24
&IpsecServerName=test
&EffectImmediately=false
&IkeConfig={"IkeVersion":"ikev2","IkeMode":"main","IkeEncAlg":"aes","IkeAuthAlg":"sha1","IkePfs":"group2","IkeLifetime":86400}
&IpsecConfig={"IpsecEncAlg":"aes","IpsecAuthAlg":"sha1","IpsecPfs":"group2","IpsecLifetime":86400}
&PskEnabled=true
&Psk=Cfd123****
&ClientToken=e4567-e89b-12d3-a456-42665544****
&DryRun=false
&公共请求参数

正常返回示例

XML格式

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

</UpdateIpsecServerResponse>
<RequestId>B61C08E5-403A-46A2-96C1-F7B1216DB10C</RequestId>
</UpdateIpsecServerResponse>

JSON格式

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

{
  "RequestId" : "B61C08E5-403A-46A2-96C1-F7B1216DB10C"
}

错误码

HttpCode 错误码 错误信息 描述
400 VpnGateway.Configuring The specified service is configuring. 服务正在配置中,请您稍后再试。
400 VpnGateway.FinancialLocked The specified service is financial locked. 该服务已欠费,请您先充值再操作。
400 IllegalParam.LocalSubnet The specified "LocalSubnet" (%s) is invalid. 本端网段(%s)不合法。
400 SystemBusy The system is busy. Please try again later. 当前系统繁忙,请稍后重试。
403 Forbidden User not authorized to operate on the specified resource. 您没有权限操作指定资源,请申请权限后再操作。

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