文档

CreateIpsecServer - 创建IPsec服务端

更新时间:

调用CreateIpsecServer接口创建IPsec服务端。

接口说明

  • 创建 IPsec 服务端前,您需要先创建 VPN 网关并确保已开启 VPN 网关的 SSL-VPN 功能。具体操作,请参见 CreateVpnGateway
  • 创建 IPsec 服务端前,需确保 VPN 网关实例下不存在 IPsec 连接。具体操作,请参见 DeleteVpnConnection
  • CreateIpsecServer 接口属于异步接口,即系统先返回一个实例 ID,但该 IPsec 服务端尚未创建成功,系统后台的创建任务仍在进行。您可以调用 DescribeVpnGateway 查询 VPN 网关实例的状态,来确定 IPsec 服务端的创建状态:
    • 当 VPN 网关实例处于 updating 状态时,表示 IPsec 服务端正在创建中。
    • 当 VPN 网关实例处于 active 状态时,表示 IPsec 服务端创建成功。
  • CreateIpsecServer 接口不支持在同一 VPN 网关下并发创建 IPsec 服务端。

调试

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

授权信息

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

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

请求参数

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

VPN 网关所属地域 ID。

cn-hangzhou
VpnGatewayIdstring

VPN 网关实例 ID。

vpn-bp17lofy9fd0dnvzv****
LocalSubnetstring

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

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

192.168.0.0/24
ClientIpPoolstring

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

说明 客户端网段不能和 VPC 侧网段冲突。
10.0.0.0/24
IpSecServerNamestring

IPsec 服务端名称。

名称长度为 1~100 个字符。

test
EffectImmediatelyboolean

配置是否立即生效。取值:

  • true:配置完成后立即进行协商。

  • false(默认值):当有流量进入时进行协商。

true
IkeConfigstring

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

  • 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 地址格式,默认值为空。

{"IkeVersion":"ikev2","IkeMode":"main","IkeEncAlg":"aes","IkeAuthAlg":"sha1","IkePfs":"group2","IkeLifetime":86400}
IpsecConfigstring

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

  • IpsecEncAlg:第二阶段协商的加密算法。默认值:aes

  • IpsecAuthAlg:第二阶段协商的认证算法。默认值:sha1

  • IpsecPfs:转发所有协议的报文。第二阶段协商使用的 Diffie-Hellman 密钥交换算法。默认值:group2

  • IpsecLifetime:第二阶段协商出的 SA 的生存周期。单位:秒,取值范围:0~86400,默认值:86400

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

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

说明 本参数必填。
true
Pskstring

预共享密钥。

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

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

说明 IPsec 服务端的预共享密钥需和客户端的认证密钥一致,否则 IPsec 服务端和客户端之间无法建立连接。
Cfd123****
ClientTokenstring

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

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

说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
d7d24a21-f4ba-4454-9173-b38****
DryRunstring

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

  • true:只预检此次请求,不会创建 IPsec 服务端。检查项包括是否填写了必需参数、请求格式、业务限制等。如果检查不通过,则返回对应错误信息。如果检查通过,则返回DryRunOperation

  • false(默认值):发送正常请求,通过检查后直接创建 IPsec 服务端。

false

返回参数

名称类型描述示例值
object

返回结果。

CreationTimestring

IPsec 服务端创建时间。

T 表示分隔符,Z 表示的是 UTC,即世界标准时间。

2021-02-22T03:24:28Z
IpsecServerIdstring

IPsec 服务端 ID。

iss-bp1jougp8cfsbo8y9****
RequestIdstring

请求 ID。

690A967E-D4CD-4B69-8C78-94FE828BA10B
IpsecServerNamestring

IPsec 服务端名称。

test
VpnGatewayIdstring

VPN 网关实例 ID。

vpn-bp17lofy9fd0dnvzv****
RegionIdstring

VPN 网关所属地域 ID。

cn-hangzhou

示例

正常返回示例

JSON格式

{
  "CreationTime": "2021-02-22T03:24:28Z",
  "IpsecServerId": "iss-bp1jougp8cfsbo8y9****",
  "RequestId": "690A967E-D4CD-4B69-8C78-94FE828BA10B",
  "IpsecServerName": "test",
  "VpnGatewayId": "vpn-bp17lofy9fd0dnvzv****",
  "RegionId": "cn-hangzhou"
}

错误码

HTTP status code错误码错误信息描述
400OperationUnsupported.IPsecServerThe current version of the VPN gateway does not support IPsec server.当前VPN网关版本不支持IPsec服务端。
400VpnGateway.SslVpnDisabledThe VPN gateway has not enabled SSL VPN.VPN网关没有开启SSL VPN功能。
400VpnGateway.ConfiguringThe specified service is configuring.服务正在配置中,请您稍后再试。
400VpnGateway.FinancialLockedThe specified service is financial locked.该服务已欠费,请您先充值再操作。
400OperationFailed.IPsecServerExistAn IPsec server already exists in the VPN gateway.VPN网关中已经存在一个IPsec服务端。
400OperationUnsupported.IpsecPfsThe specified IPsec Pfs is unsupported.不支持指定的IPsec Pfs
400IllegalParam.AuthMethodOne authentication method (Psk or IDaaS) should be specified at least.至少有一种认证方法(Psk或者IDaas)应该被指定
400IllegalParam.LocalSubnetThe specified "LocalSubnet" (%s) is invalid.本端网段(%s)不合法。
400IllegalParam.ClientIpPoolThe specified ClientIpPool (%s) is invalid.客户端网段(%s)不合法。
400MissingParam.IDaaSInstanceIdThe input parameter IDaaSInstanceId is mandatory when enable multi-factor authentication.当开启双因子认证时,IDaaS实例ID是必填的参数
400OperationFailed.NoRamPermissionVpn Service has no permission to operate your IDaaS instances.Vpn服务没有权限操作您的IDaaS实例
400ClientIpPool.NetmaskInvalidThe netmask length of client IP pool must be greater than or equal to 16 and less than or equal to 29.客户端 IP 池的网络掩码长度必须大于等于 16 且小于等于 29。
400VpnRouteEntry.ConflictThe specified client IP pool conflicts with VPN connection or SSL server.指定的客户端 IP 池与 VPN 连接或 SSL 服务端冲突。
400ClientIpPool.SubnetInvalidThe specified client IP pool cannot be used.当前客户端网段不可用。
400InvalidClientIpPool.ConflictThe specified client IP pool conflicts with other resources in the same VPC.客户端网段与VPC内其他资源冲突。
400OperationFailed.AddVpcRouteIt is failed to add VPC route after this operation.此操作后添加 VPC 路由失败。
400QuotaExceeded.VpnRouteEntryThe number of route entries to the VPN gateway in the VPC routing table has reached the quota limit.VPC路由表中指向VPN网关的路由条目已经达到配额限制。
400SystemBusyThe system is busy. Please try again later.当前系统繁忙,请稍后重试。
400EnableHaCheck.IpsecServerCidrContainsVpcRouteDestIpsec server client cidr contains vpc route prefix. The vpc route prefix is %s.vpc路由表中存在路由的前缀%s被包含在ipsec server 客户端 cidr 中。
400VpnGateway.IPsecServerAndVpnConnectionConflictThe IPSec connection and IPSec server cannot be configured on the same VPN gateway at the same time.一个VPN网关不支持同时配置IPSec服务端与IPSec连接。
403ForbiddenUser not authorized to operate on the specified resource.您没有权限操作指定资源,请申请权限后再操作。
404InvalidVpnGatewayInstanceId.NotFoundThe specified vpn gateway instance id does not exist.指定的 VPN 网关不存在,请您检查 VPN 网关是否正确。
404InvalidIDaaSInstanceId.NotFoundThe specified IDaaS instance ID does not exist.指定的IDaaS实例ID不存在
409OperationConflictThe operation against this instance is too frequent, please try again later.对该实例的操作过于频繁,请稍后重试。

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

变更历史

变更时间变更内容概要操作
2024-01-04OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:403
    删除错误码:404
    删除错误码:409
2023-10-19OpenAPI 描述信息更新、OpenAPI 错误码发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:403
    删除错误码:404
    删除错误码:409
  • 本页导读 (1)
文档反馈