调用DescribeSslVpnServers接口查询已创建的SSL-VPN服务端。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 DescribeSslVpnServers

系统规定参数。取值：DescribeSslVpnServers。

RegionId String 是 cn-hangzhou

SSL-VPN服务端所在的地域ID。

您可以通过调用DescribeRegions接口获取地域ID。

SslVpnServerId String 否 vss-bp15j3du13gq1dgey****

SSL-VPN服务端的ID。
VpnGatewayId String 否 vpn-bp1on0xae9d771ggi****

VPN网关的ID。
Name String 否 test

SSL-VPN服务端的名称。

长度为1～100个字符，不能以http://或https://开头。

PageNumber Integer 否 1

列表的页码，默认值：1。

PageSize Integer 否 10

分页查询时每页的行数。最大值：50。默认值：10。

返回数据

名称 类型 示例值 描述
PageSize Integer 10

分页查询时每页的行数。
RequestId String D350187B-EA41-4577-950B-95434C8302E1

请求ID。
PageNumber Integer 1

列表的页码。
TotalCount Integer 1

列表条目数。
SslVpnServers Array of SslVpnServer

SSL-VPN服务端的详细信息。
SslVpnServer
InternetIp String 47.5.XX.XX

VPN网关的公网IP地址。
IDaaSInstanceId String idaas-cn-hangzhou-****

IDaaS实例ID。
CreateTime Long 1613800884000

创建SSL-VPN服务端的时间戳。
VpnGatewayId String vpn-bp1on0xae9d771ggi****

VPN网关ID。
IDaaSRegionId String cn-hangzhou

IDaaS实例所属地域ID。
Compress Boolean false

是否对通信进行压缩。

  • true：是。
  • false（默认值）：否。
Port Integer 1194

SSL-VPN服务端所使用的端口。
LocalSubnet String 192.168.0.0/24

本端网段。
RegionId String cn-hangzhou

SSL-VPN服务端的地域ID。
Cipher String AES-128-CBC

使用的加密算法。
Connections Integer 0

当前连接数。
SslVpnServerId String vss-bp15j3du13gq1dgey****

SSL-VPN服务端的ID。
MaxConnections Integer 5

最大连接数。
Name String test

SSL-VPN服务端名称。
EnableMultiFactorAuth Boolean true

是否开启了双因子认证。

  • true：已开启。
  • false（默认值）：未开启。
ClientIpPool String 10.10.1.0/24

客户端网段。
Proto String UDP

SSL-VPN服务端所使用的协议。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeSslVpnServers
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML格式 

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

<DescribeSslVpnServersResponse>
    <PageSize>10</PageSize>
    <RequestId>D350187B-EA41-4577-950B-95434C8302E1</RequestId>
    <PageNumber>1</PageNumber>
    <TotalCount>1</TotalCount>
    <SslVpnServers>
        <InternetIp>47.5.XX.XX</InternetIp>
        <IDaaSInstanceId>idaas-cn-hangzhou-****</IDaaSInstanceId>
        <CreateTime>1613800884000</CreateTime>
        <VpnGatewayId>vpn-bp1on0xae9d771ggi****</VpnGatewayId>
        <IDaaSRegionId>cn-hangzhou</IDaaSRegionId>
        <Compress>false</Compress>
        <Port>1194</Port>
        <LocalSubnet>192.168.0.0/24</LocalSubnet>
        <RegionId>cn-hangzhou</RegionId>
        <Cipher>AES-128-CBC</Cipher>
        <Connections>0</Connections>
        <SslVpnServerId>vss-bp15j3du13gq1dgey****</SslVpnServerId>
        <MaxConnections>5</MaxConnections>
        <Name>test</Name>
        <EnableMultiFactorAuth>true</EnableMultiFactorAuth>
        <ClientIpPool>10.10.1.0/24</ClientIpPool>
        <Proto>UDP</Proto>
    </SslVpnServers>
</DescribeSslVpnServersResponse>

JSON格式 

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

{
  "PageSize" : 10,
  "RequestId" : "D350187B-EA41-4577-950B-95434C8302E1",
  "PageNumber" : 1,
  "TotalCount" : 1,
  "SslVpnServers" : [ {
    "InternetIp" : "47.5.XX.XX",
    "IDaaSInstanceId" : "idaas-cn-hangzhou-****",
    "CreateTime" : 1613800884000,
    "VpnGatewayId" : "vpn-bp1on0xae9d771ggi****",
    "IDaaSRegionId" : "cn-hangzhou",
    "Compress" : false,
    "Port" : 1194,
    "LocalSubnet" : "192.168.0.0/24",
    "RegionId" : "cn-hangzhou",
    "Cipher" : "AES-128-CBC",
    "Connections" : 0,
    "SslVpnServerId" : "vss-bp15j3du13gq1dgey****",
    "MaxConnections" : 5,
    "Name" : "test",
    "EnableMultiFactorAuth" : true,
    "ClientIpPool" : "10.10.1.0/24",
    "Proto" : "UDP"
  } ]
}

错误码

HttpCode 错误码 错误信息 描述
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. 您没有权限操作指定资源，请申请权限后再操作。

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