文档中心>API 中心

设置SSL VPN域

最近更新时间:2019-12-02 17:02:35

我的收藏

1. 接口描述

本接口(SetSSLVpnDomain)用于设置 SSL VPN 域。 接口请求域名:vpc.api.qcloud.com

2. 输入参数

以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,详情请参见 公共请求参数 页面。其中,此接口的 Action 字段为 SetSSLVpnDomain。
参数名称
是否必选
类型
描述
vpcId
Int
私有网络 ID 值,可使用 vpcId 或 unVpcId,建议使用 unVpcId。可通过 DescribeVpcEx 接口查询。
sslVpnId
Int
系统分配的 SSL VPN 网关 ID,例如 vpngw-l2tlvgb9。可通过 DescribeSSLVpn 接口查询。
groupId
String
域的工作组。
ipPool.n
Array
SSL VPN 终端 IP 段。
acl.n
Array
ACL 策略。
acl.n.proto
String
ACL 协议,例如 tcp。
acl.n.action
String
ACL 策略,0:允许,1:拒绝。
acl.n.destinationPort
String
目的端口。
acl.n.sourceCidr
String
源 IP 或源网段。
acl.n.destinationCidr
String
目的 IP 或目的网段。

3. 输出参数

参数名称
类型
描述
code
Int
错误码, 0: 成功, 其他值: 失败
message
String
错误信息
taskId
Int
任务 ID,操作结果可以用 taskId 查询,详见 查询任务执行结果接口

4. 错误码表

该接口没有业务错误码,公共错误码详见 VPC 错误码

5. 示例

输入
https://vpc.api.qcloud.com/v2/index.php?Action=SetSSLVpnDomain
&<公共请求参数>
&vpcId=vpc-39lpv32n
&sslVpnId=vpngw-m1ue61hx
&groupId=ugrp-975r1ku4
&sslvpnPort=443
&ipPool.0=192.168.16.119-192.168.16.121
输出
{
"code": 0,
"message": "",
"data": {
"taskId": 13161
}
}