1. 接口描述
本接口(DescribeSSLVpnDomain)用于查询 SSL VPN 域。
接口请求域名:vpc.api.qcloud.com
2. 输入参数
以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,详情请参见 公共请求参数 页面。其中,此接口的 Action 字段为 DescribeSSLVpnDomain。
参数名称 | 是否必选 | 类型 | 描述 |
---|---|---|---|
vpcId | 是 | Int | 私有网络 ID 值,可使用 vpcId 或 unVpcId,建议使用 unVpcId。可通过 DescribeVpcEx 接口查询。 |
sslVpnId | 是 | Int | 系统分配的 SSL VPN 网关 ID,例如 vpngw-l2tlvgb9。可通过 DescribeSSLVpn 接口查询。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
code | Int | 错误码,0: 成功,其他值: 失败。 |
message | String | 错误信息。 |
data.n | Array | 返回的 SSL VPN 域信息 |
data.n.groupId | String | 工作组 ID,例如 ugrp-8zbvqpea。 |
data.n.ipPool | Array | 终端 IP 段。 |
data.n.acl.n | Array | ACL 策略信息数组。 |
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 或目的网段。 |
4. 错误码表
该接口没有业务错误码,公共错误码详见 VPC 错误码。
5. 示例
输入
https://vpc.api.qcloud.com/v2/index.php?Action=DescribeSSLVpnDomain &<公共请求参数> &vpcId=93 &sslVpnId=vpngw-l2tlvgb9 &groupId=dgdgd &sslVpnPort=442
输出
{
"code": 0,
"message": "",
"data": [
{
"groupId": "ugrp-8zbvqpea",
"ipPool": [
"172.23.138.16-172.23.138.20"
],
"acl": [
{
"proto": "all",
"action": 1,
"destinationPort": 0,
"sourceCidr": "0.0.0.0\/0",
"destinationCidr": "0.0.0.0\/0"
}
]
}
]
}