调用UpdateIpsecServer接口更新IPsec服务端配置。
接口说明
- 如果您只修改 IPsec 服务端的 IpsecServerName 信息时该接口为同步接口,如果您修改了除 IpsecServerName 之外的配置,该接口为异步接口。
- 当 UpdateIpsecServer 接口为异步接口时,系统会先返回一个请求 ID,但该 IPsec 服务端的配置尚未修改成功,系统后台的修改任务仍在进行。您可以调用 DescribeVpnGateway 查询 VPN 网关实例的状态,来确定 IPsec 服务端配置的修改状态:
- 当 VPN 网关实例处于 updating 状态时,表示 IPsec 服务端的配置正在修改中。
- 当 VPN 网关实例处于 active 状态时,表示 IPsec 服务端的配置修改成功。
- UpdateIpsecServer 接口不支持在同一 VPN 网关下并发修改 IPsec 服务端的配置。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
vpc:UpdateIpsecServer | update | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | IPsec 服务端所属地域 ID。 您可以通过调用 DescribeRegions 接口获取地域 ID。 | cn-shanghai |
IpsecServerId | string | 是 | IPsec 服务端 ID。 | iss-bp1bo3xuvcxo7ixll**** |
LocalSubnet | string | 否 | 本端网段,指需要和客户端网段互连的 VPC 侧的网段。 多个网段之间用半角逗号(,)分隔,例如:192.168.1.0/24,192.168.2.0/24。 | 192.168.0.0/24,172.17.0.0/16 |
ClientIpPool | string | 否 | 客户端网段,指给客户端虚拟网卡分配访问地址的网段。 说明
客户端网段不能和 VPC 侧网段冲突。
| 10.0.0.0/24 |
IpsecServerName | string | 否 | IPsec 服务端名称。 长度为 1~100 个字符。 | test |
EffectImmediately | boolean | 否 | 是否删除当前已协商成功的 IPsec 隧道并重新发起协商。取值:
| false |
IkeConfig | string | 否 | 第一阶段协商参数配置。取值:
| {"IkeVersion":"ikev2","IkeMode":"main","IkeEncAlg":"aes","IkeAuthAlg":"sha1","IkePfs":"group2","IkeLifetime":86400} |
IpsecConfig | string | 否 | 第二阶段协商参数配置。取值:
| {"IpsecEncAlg":"aes","IpsecAuthAlg":"sha1","IpsecPfs":"group2","IpsecLifetime":86400} |
PskEnabled | boolean | 否 | 是否开启预共享密钥认证方式。取值:true,表示开启预共享密钥认证方式。 | true |
Psk | string | 否 | 预共享密钥。 用于 IPsec 服务端与客户端之间的身份认证。密钥长度为 1~100 个字符。 您可以调用 ListIpsecServers 接口查询系统生成的密钥信息。 说明
IPsec 服务端的预共享密钥需和客户端的认证密钥一致,否则 IPsec 服务端和客户端之间无法建立连接。
| Cfd123**** |
ClientToken | string | 否 | 客户端 Token,用于保证请求的幂等性。 从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。 说明
若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
| e4567-e89b-12d3-a456-42665544**** |
DryRun | string | 否 | 是否只预检此次请求,取值:
| false |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "B61C08E5-403A-46A2-96C1-F7B1216DB10C"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | VpnGateway.Configuring | The specified service is configuring. | 服务正在配置中,请您稍后再试。 |
400 | VpnGateway.FinancialLocked | The specified service is financial locked. | 该服务已欠费,请您先充值再操作。 |
400 | OperationUnsupported.IpsecPfs | The specified IPsec Pfs is unsupported. | 不支持指定的IPsec Pfs |
400 | IllegalParam.AuthMethod | One authentication method (Psk or IDaaS) should be specified at least. | 至少有一种认证方法(Psk或者IDaas)应该被指定 |
400 | IllegalParam.LocalSubnet | The specified "LocalSubnet" (%s) is invalid. | 本端网段(%s)不合法。 |
400 | IllegalParam.ClientIpPool | The specified "ClientIpPool" (%s) is invalid. | - |
400 | MissingParam.IDaaSInstanceId | The input parameter IDaaSInstanceId is mandatory when enable multi-factor authentication. | 当开启双因子认证时,IDaaS实例ID是必填的参数 |
400 | OperationFailed.NoRamPermission | Vpn Service has no permission to operate your IDaaS instances. | Vpn服务没有权限操作您的IDaaS实例 |
400 | OperationFailed.AddVpcRoute | It's failed to add VPC route after this operation. | - |
400 | ClientIpPool.NetmaskInvalid | The netmask length of client IP pool must be greater than or equal to 16 and less than or equal to 29. | 客户端 IP 池的网络掩码长度必须大于等于 16 且小于等于 29。 |
400 | VpnRouteEntry.Conflict | The specified client IP pool conflicts with VPN connection or SSL server. | 指定的客户端 IP 池与 VPN 连接或 SSL 服务端冲突。 |
400 | ClientIpPool.SubnetInvalid | The specified client IP pool cannot be used. | 当前客户端网段不可用。 |
400 | InvalidClientIpPool.Conflict | The specified client IP pool conflicts with other resources in the same VPC. | 客户端网段与VPC内其他资源冲突。 |
400 | SystemBusy | The system is busy. Please try again later. | 当前系统繁忙,请稍后重试。 |
403 | Forbidden | User not authorized to operate on the specified resource. | 您没有权限操作指定资源,请申请权限后再操作。 |
404 | InvalidIpsecServerId.NotFound | The specified IPsec server ID (%s) does not exist. | - |
404 | InvalidIDaaSInstanceId.NotFound | The specified IDaaS instance ID does not exist. | 指定的IDaaS实例ID不存在 |
409 | OperationConflict | The operation against this instance is too frequent, please try again later. | 对该实例的操作过于频繁,请稍后重试。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-10-19 | OpenAPI 描述信息更新、OpenAPI 错误码发生变更 | 查看变更详情 |
2023-08-08 | OpenAPI 描述信息更新、OpenAPI 错误码发生变更 | 查看变更详情 |