调用ModifySslVpnServer接口修改SSL-VPN服务端的配置信息

使用说明

当只修改SSL-VPN服务端Name信息时该接口为同步接口，如果还修改了除Name之外的配置，该接口为异步接口。
ModifySslVpnServer接口为异步接口时，即系统先返回一个请求ID，但该SSL-VPN服务端的配置信息尚未修改成功，系统后台的修改任务仍在进行。您可以调用DescribeVpnGateway接口查询SSL-VPN服务端关联的VPN网关实例的状态，来确认SSL-VPN服务端配置信息的修改状态：
- 当VPN网关实例处于updating状态时，表示SSL-VPN服务端的配置信息正在修改中。
- 当VPN网关实例处于active状态时，表示SSL-VPN服务端的配置信息修改成功。
ModifySslVpnServer接口不支持在同一VPN网关下并发修改SSL-VPN服务端的配置信息。

调试

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

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	ModifySslVpnServer	系统规定参数。取值：ModifySslVpnServer。
ClientToken	String	否	02fb3da4-130e-11e9-8e44-0016e04115b	客户端Token，用于保证请求的幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。说明若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。
RegionId	String	是	cn-hangzhou	VPN网关所在的地域ID。您可以通过调用DescribeRegions接口获取地域ID。
SslVpnServerId	String	是	vss-bp18q7hzj6largv4v****	SSL-VPN服务端实例ID。
Name	String	否	test	SSL-VPN服务端的名称。长度为1～100个字符，不能以`http://`或`https://`开头。
ClientIpPool	String	否	10.30.30.0/24	客户端IP地址池。
LocalSubnet	String	否	10.20.20.0/24	本地客户端的网段。
Proto	String	否	UDP	SSL-VPN服务端所使用的协议，取值： TCP：TCP协议。 UDP（默认值）：UDP协议。
Cipher	String	否	AES-128-CBC	SSL-VPN使用的加密算法，取值： AES-128-CBC（默认值）：AES-128-CBC算法。 AES-192-CBC：AES-192-CBC算法。 AES-256-CBC：AES-256-CBC算法。 none：不使用加密算法。
Port	Integer	否	1194	SSL-VPN服务端所使用的端口，默认值：1194。不能用使用以下端口： 22、2222、22222、9000、9001、9002、7505、80、443、53、68、123、4510、4560、500、4500。
Compress	Boolean	否	true	指定是否对通信进行压缩，取值： true（默认值）：对通信进行压缩。 false：对通信不进行压缩。
EnableMultiFactorAuth	Boolean	否	false	是否开启了双因子认证。 true：已开启。 false（默认值）：未开启。
IDaaSInstanceId	String	否	idaas-cn-hangzhou-****	IDaaS实例ID。
IDaaSRegionId	String	否	cn-hangzhou	IDaaS实例所属地域ID。

返回数据


名称	类型	示例值	描述
InternetIp	String	47.98.XX.XX	公网IP。
IDaaSInstanceId	String	idaas-cn-hangzhou-****	IDaaS实例ID。
CreateTime	Long	1492753580000	SSL-VPN服务端的创建时间。
VpnGatewayId	String	vpn-bp1q8bgx4xnkm2ogj****	VPN网关实例ID。
Compress	Boolean	false	是否压缩通信。
Port	Integer	1194	SSL-VPN服务端的端口。
LocalSubnet	String	10.20.20.0/24	本地客户端地址段。
RegionId	String	cn-hangzhou	SSL-VPN服务端的地域ID。
Cipher	String	AES-128-CBC	使用的加密算法。
RequestId	String	DF11D6F6-E35A-41C3-9B20-6FC8A901FE65	请求ID。
Connections	Integer	0	当前连接数。
SslVpnServerId	String	vss-bp18q7hzj6largv4v****	SSL-VPN服务端的ID。
MaxConnections	Integer	5	最大连接数。
Name	String	test	SSL-VPN服务端的名称。
EnableMultiFactorAuth	Boolean	false	是否开启了双因子认证。 true：已开启。 false（默认值）：未开启。
ClientIpPool	String	10.30.30.0/24	客户端IP地址池。
Proto	String	UDP	SSL-VPN服务端使用的协议。

示例

请求示例

https://vpc.aliyuncs.com/?Action=ModifySslVpnServer
&RegionId=cn-hangzhou
&SslVpnServerId=vss-bp18q7hzj6largv4****
&<公共请求参数>

正常返回示例

XML格式

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

<ModifySslVpnServerResponse>
    <InternetIp>47.98.XX.XX</InternetIp>
    <IDaaSInstanceId>idaas-cn-hangzhou-****</IDaaSInstanceId>
    <CreateTime>1492753580000</CreateTime>
    <VpnGatewayId>vpn-bp1q8bgx4xnkm2ogj****</VpnGatewayId>
    <Compress>false</Compress>
    <Port>1194</Port>
    <LocalSubnet>10.20.20.0/24</LocalSubnet>
    <RegionId>cn-hangzhou</RegionId>
    <Cipher>AES-128-CBC</Cipher>
    <RequestId>DF11D6F6-E35A-41C3-9B20-6FC8A901FE65</RequestId>
    <Connections>0</Connections>
    <SslVpnServerId>vss-bp18q7hzj6largv4v****</SslVpnServerId>
    <MaxConnections>5</MaxConnections>
    <Name>test</Name>
    <EnableMultiFactorAuth>false</EnableMultiFactorAuth>
    <ClientIpPool>10.30.30.0/24</ClientIpPool>
    <Proto>UDP</Proto>
</ModifySslVpnServerResponse>

JSON格式

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

{
  "InternetIp" : "47.98.XX.XX",
  "IDaaSInstanceId" : "idaas-cn-hangzhou-****",
  "CreateTime" : 1492753580000,
  "VpnGatewayId" : "vpn-bp1q8bgx4xnkm2ogj****",
  "Compress" : false,
  "Port" : 1194,
  "LocalSubnet" : "10.20.20.0/24",
  "RegionId" : "cn-hangzhou",
  "Cipher" : "AES-128-CBC",
  "RequestId" : "DF11D6F6-E35A-41C3-9B20-6FC8A901FE65",
  "Connections" : 0,
  "SslVpnServerId" : "vss-bp18q7hzj6largv4v****",
  "MaxConnections" : 5,
  "Name" : "test",
  "EnableMultiFactorAuth" : false,
  "ClientIpPool" : "10.30.30.0/24",
  "Proto" : "UDP"
}

错误码


HttpCode	错误码	错误信息	描述
400	InvalidName	The name is not valid	该名称格式不合法。
400	VpnGateway.Configuring	The specified service is configuring.	服务正在配置中，请您稍后再试。
400	VpnGateway.FinancialLocked	The specified service is financial locked.	该服务已欠费，请您先充值再操作。
400	SslVpnServer.AddRouteError	Add route error whose destination is client IP pool, please check vpc route entry and relevant quota.	添加指向客户端网段的路由失败，请查看vpc路由条目及相关配额。
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	ClientIpPool.SubnetInvalid	The specified client IP pool cannot be used.	当前客户端网段不可用。
400	MissingParameter.IDaaSInstanceId	The input parameter IDaaSInstanceId is mandatory when enable multi-factor authentication.	启动双因子认证时请输入IDaaSInstanceId参数。
400	OperationFailed.NoRamPermission	Vpn Service has no permission to operate your IDaaS instances.	Vpn服务没有权限操作您的IDaaS实例
400	SystemBusy	The system is busy. Please try again later.	当前系统繁忙，请稍后重试。
403	Forbbiden.SubUser	User not authorized to operate on the specified resource as your account is created by another user.	您没有权限操作该资源，请您申请操作权限后再试。
403	Forbidden	User not authorized to operate on the specified resource.	您没有权限操作指定资源，请申请权限后再操作。

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