ModifySslVpnServer--VPN连接-火山引擎

文档中心

立即注册

导航

ModifySslVpnServer

最近更新时间：2024.11.15 09:42:56首次发布时间：2023.07.28 08:04:08

调用ModifySslVpnServer修改SSL服务端的名称、描述、本端网段、客户端网段、加密算法、认证算法等相关信息。

操作说明

说明

修改SSL服务端信息，可能会导致业务中断，请谨慎操作。

修改LocalSubnets.N、ClientIpPool、Compress，会出现该SSL服务端下所有的SSL VPN连接中断，请在修改完成后从客户端重新发起连接。
修改Port、Auth、Cipher、Protocol，会出现该SSL服务端下所有的SSL VPN连接中断，使用该SSL服务端创建的SSL客户端证书失效，请在修改完成后重新下载SSL客户端证书，然后在客户端中安装新证书，并从客户端发起SSL VPN连接。

调试

API Explorer

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

去调试

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	ModifySslVpnServer	要执行的操作，取值：ModifySslVpnServer。
Version	String	是	2020-04-01	API版本信息。
SslVpnServerId	String	是	vss-zm55pqtvk17oq32zd****	待修改的SSL服务端的ID。您可调用 DescribeSslVpnServers查询SSL服务端的ID信息。
Description	String	否	This is a ssl description	SSL服务端的描述信息。以中文、字母、数字开头，只能包含中文、字母、数字、点号（.）、空格（）、下划线（_）、中划线（-）、等号（=）、英文逗号（,）、中文逗号（，）、中文句号（。）。长度限制为0 ~ 255个字符。不填保持原有配置。
SslVpnServerName	String	否	test-ssl-vpn	SSL服务端的名称。以中文、字母、数字开头，只能包含中文、字母、数字、点号（.）、下划线（_）和短划线（-）长度限制为1 ~ 128个字符。不填保持原有配置。
Auth	String	否	SHA1	认证算法。 SHA1 MD5 None（不使用加密）不填保持原有配置。
Cipher	String	否	AES-128-CBC	加密算法。 AES-128-CBC AES-192-CBC AES-256-CBC None （不使用加密）不填保持原有配置。
ClientIpPool	String	否	192.168.1.0/24	客户端网段。该网段不能与`LocalSubnet`地址段冲突，也不能与IPSec连接路由冲突。该网段禁止和本端网段、`100.64.0.0/10`、`169.254.0.0/16`、`224.0.0.0/3`、 `127.0.0.0/8`、`240.0.0.0/4`重叠。掩码下所含IP需要大于VPN网关所选SSL连接规格的4倍。不填保持原有配置。
Compress	Boolean	否	false	指定是否对通信进行压缩。 true：对通信进行压缩。 false：对通信不进行压缩。不填保持原有配置。
LocalSubnets.N	List of String	否	LocalSubnets.1=172.XX.1.0/24&LocalSubnets.2=172.XX.2.0/24	本段网段。本端网段掩码推荐：`/8`～`/32`。本端网段不可与客户端网段冲突。不填保持原有配置。
Port	Integer	否	1194	SSL服务端所使用的端口。默认值：1194。端口取值范围：1~65535。不支持使用以下端口：22，68，179，323，500，4500。不填保持原有配置。
Protocol	String	否	UDP	SSL服务端所使用的协议，取值： TCP：TCP协议。 UDP：UDP协议。不填保持原有配置。

返回数据

名称	类型	示例值	描述
RequestId	String	0E006-F706-4D23-88ED-E11ED28DC****	请求ID。

请求示例

GET /?Action=ModifySslVpnServer&Version=2020-04-01&SslVpnServerId=vss-2feyndgkcdbsw59gp68i****&Description=test&SslVpnServerName=test-ssl HTTP/1.1
Host: open.volcengineapi.com
ServiceName: vpn
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230727194730FAE73E7FF21AA2FB****",
        "Action": "ModifySslVpnServer",
        "Version": "2020-04-01",
        "Service": "vpn",
        "Region": "cn-beijing"
    },
    "Result": {
        "RequestId": "20230727194730FAE73E7FF21AA2FB****"
    }
}

错误码

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

HttpCode	错误码	错误信息	描述
400	InvalidDescription.Malformed	The specified description is malformed.	指定的描述格式不合法。请修复描述格式后重试。
400	InvalidDescription.Malformed	The specified description is malformed. Ensure the maximum length of description is 255.	指定的描述格式不合法。描述长度不能超过255个字符。
400	InvalidName.Malformed	The specified name is malformed. Ensure the maximum length of name is 128.	指定的名称格式不合法。名称长度不能超过128个字符。
400	InvalidName.Malformed	The specified name is malformed.	指定的名称格式不合法。请修复名称格式后重试。
400	InvalidSslVpnServer.InvalidStatus	The specified SSL server is not in the correct status for the request.	指定的SSL服务端所处的状态无法响应该请求。
400	InvalidCidr.Malformed	The specified cidr block is malformed.	指定的网段格式不合法。
400	InvalidClientIpPool.NotEnough	The support ip numbers of ClientIpPool is smaller than SslMaxConnections of vpn gateway.	客户端网段支持的IP数量小于网关所选的连接规格。
400	InvalidSslVpnClientIpPool.Conflict	The specified ClientIpPool conflicts with that of local subnets.	指定的客户端网段与本端网段存在冲突。
400	InvalidSslVpnServerAuth.Malformed	The specified Auth is malformed.	指定的SSL服务端认证算法不合法。
400	InvalidSslVpnServerCipher.Malformed	The specified Cipher is malformed.	指定的SSL服务端加密算法不合法。
400	InvalidSslVpnServerClientIpPool.Malformed	The specified ClientIpPool is malformed.	指定的客户端网段不合法。
400	InvalidSslVpnServerClientIpPool.VpcRouteEntry	Failed to create route entry in the system route table of the VPC contains the specified VPN gateway for the client ip pool.	VPN网关所属VPC路由表中添加指向客户端网段的路由失败。
400	InvalidSslVpnServerClientIpPoolMask.Malformed	The netmask length of client IP pool must be greater than or equal to 16 and less than or equal to 28.	指定的客户端网段掩码必须大于等于16且小于等于28。
400	InvalidSslVpnServerLocalSubnet.Conflict	There are conflicting CIDRs in the specified LocalSubnets.	指定本端网段之间存在相互冲突的网段。
400	InvalidSslVpnServerLocalSubnet.Malformed	The specified LocalSubnet is malformed.	指定的本端网段不合法。
400	InvalidSslVpnServerPort.Malformed	The specified ssl vpn server port is invalid.	指定的SSL服务端端口值不合法。
400	InvalidSslVpnServerProtocol.Malformed	The specified Protocol is malformed.	指定的SSL服务端协议不合法。
400	InvalidVpnGateway.InvalidStatus	The specified VPN gateway is not in the correct status for the request.	指定的VPN网关所处的状态无法响应该请求。
400	LimitExceeded.SslVpnServerLocalSubnets	You've reached the limit on the number of local subnets per SSL server that you can create.	已达到每个SSL服务端可以配置的本端网段的数量上限。
400	QuotaExceeded.VpcRouteEntry	You've reached the limit on the number of route entry in the system route table of the VPC contains the specified VPN gateway that you can create.	已达到指定VPN网关所属VPC系统路由表可创建路由条目的数量上限。
403	Forbidden.VpnGatewayBlocked	The specified VPN gateway is blocked.	当前VPN网关封禁中，禁止操作。
404	InvalidSslVpnServer.NotFound	The specified SSL server does not exist.	指定的SSL服务端不存在。
404	InvalidVpnGateway.NotFound	The specified VPN gateway does not exist.	指定的VPN网关不存在。
409	InvalidRouteCidr.Conflict	The specified CIDR block conflicts with that of another route in your route table.	指定的CIDR地址块与所属路由表中另一个规则CIDR地址块冲突。
409	InvalidSslVpnServerVpcRouteEntry.Conflict	The specified ClientIpPool conflicts with that of another route in the system route table of the VPC contains the VPN gateway.	指定的客户端网段与VPN网关所属VPC的系统路由表中另一个规则的CIDR地址块冲突。
412	InvalidVpnGateway.Expired	The specified VPN gateway has expired.	指定的VPN网关已过期。