You need to enable JavaScript to run this app.
文档中心
VPN连接

VPN连接

复制全文
下载 pdf
SSL服务端
ModifySslVpnServer-修改SSL服务端
复制全文
下载 pdf
ModifySslVpnServer-修改SSL服务端
调用ModifySslVpnServer修改SSL服务端的名称、描述、本端网段、客户端网段、加密算法、认证算法等相关信息。​
使用说明​
本接口中的可选参数不传入值时,表示不修改。​
调试​
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 String 可选 示例值:172.XX.1.0/24​
本端网段。​
  • 本端网段掩码推荐:/8~/32。​
  • 本端网段不可与客户端网段冲突。​
​
Port Integer 可选 示例值:1194​
SSL服务端所使用的端口。​
  • 端口取值范围:1~65535。​
  • 不支持使用以下端口:22,68,179,323,500,4500。​
​
Protocol String 可选 示例值:UDP​
SSL服务端所使用的协议,取值:​
  • TCP:TCP协议。​
  • UDP:UDP协议。​
​
LogEnabled Boolean 可选 示例值:true​
是否开启SSL VPN连接日志,取值如下:​
  • true:开启​
  • false:关闭​
​
DnsServerIpAddresses.N String 可选 示例值:1.1.1.1​
DNS服务器IP,最多支持传入两个IPv4类型的IP地址。​
​
DnsDomain String 可选 示例值:ivolcs.com​
DNS解析域,仅当DnsServerIpAddresses参数有传入值时生效。​
​
ClientCertSessionPolicy String 可选 示例值:PreemptExisting​
是否开启证书复用,取值如下:​
  • AllowConcurrent(默认):启用​
  • PreemptExisting:不启用​
​
SsoAuthEnabled Boolean 可选 示例值:false​
是否开启双因子认证,取值如下:​
  • true:开启​
  • false(默认):关闭​
​
SamlData String 可选 示例值:GZ4ZDU0MmMwODYtYzAyKioqIiB4bWxuczptZD0idXJuOm9hc2lzOm5hbWVzOnRjOlNBTUw6Mi4wOm1ldGFkYXRhIj4=​
身份提供商的SAML元数据,需传入XML格式数据且经过base64加密。​
当SsoAuthEnabled取值为true时为必填。​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
RequestId String 示例值:0E006-F706-4D23-88ED-E11ED28DC****​
请求ID。​
​
​
请求示例​
​
GET /?Action=ModifySslVpnServer&Version=2020-04-01&SslVpnServerId=vss-zm55pqtvk17oq32zd****&Description=This is a ssl description&SslVpnServerName=test-ssl-vpn&Auth=SHA1&Cipher=AES-128-CBC&ClientIpPool=192.168.1.0/24&Compress=false&LocalSubnets.1=172.XX.1.0/24&Port=1194&Protocol=UDP&LogEnabled=true&DnsServerIpAddresses.1=1.1.1.1&DnsDomain=ivolcs.com&ClientCertSessionPolicy=PreemptExisting&SsoAuthEnabled=false&SamlData=GZ4ZDU0MmMwODYtYzAyKioqIiB4bWxuczptZD0idXJuOm9hc2lzOm5hbWVzOnRjOlNBTUw6Mi4wOm1ldGFkYXRhIj4= HTTP/1.1​
Host: vpn.cn-beijing.volcengineapi.com​
X-Date: 20251029T033538Z​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20251029/cn-beijing/vpn/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "20230604110420****100232280022D31",​
"Action": "ModifySslVpnServer",​
"Version": "2020-04-01",​
"Service": "vpn",​
"Region": "cn-beijing"​
},​
"Result": {​
"RequestId": "0E006-F706-4D23-88ED-E11ED28DC****"​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
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​
InvalidParameter.ClientCertSessionPolicy​
The specified ClientCertSessionPolicy is invalid.​
指定的客户端证书会话策略非法。​
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网关已过期。​
​
最近更新时间:2026.07.10 15:37:22
这个页面对您有帮助吗?
有用
有用
无用
无用