调用DescribeSslVpnServers查询SSL服务端信息。

调试

API Explorer

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

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action String 必选示例值：DescribeSslVpnServers

要执行的操作，取值：DescribeSslVpnServers。

Version String 必选示例值：2020-04-01

API版本信息。

VpnGatewayId String 可选示例值：vgw-2feyp1wmtx14w****

SSL服务端使用的VPN网关的ID。您可调用DescribeVpnGateways查询VPN网关的ID信息。

SslVpnServerName String 可选示例值：Ssl_Servers

SSL服务端的名称。

SslVpnServerIds.N String 可选示例值：vss-12b8vv10jfx8g****

SSL服务端的ID。

参数 - N：表示SSL服务端的ID的序号。

多个ID之间用&分隔。

PageSize Integer 可选示例值：20

查询结果的分页大小。最大值：100，默认值：20。

PageNumber Integer 可选示例值：1

查询结果的页码。

如需传入此参数，请传入非负整数。

不传或传入0，则均默认为1。

ProjectName String 可选示例值：Project_1

SSL服务端所属的项目。

TagFilters.N.Key String 可选示例值：key1

根据标签查询资源时指定的标签键。

参数 - N：表示标签键的序号，取值范围：1～10。

多个标签键之间用&分隔。

不允许重复。

TagFilters.N.Values.M String 可选示例值：value1

根据标签查询资源时指定的标签值。

第一个 N：表示标签键的序号，取值范围：1～10。

第二个 N：表示标签值的序号，取值范围：1～3，即同一标签键最多支持同时查询3个标签值。

多个标签值之间用&分隔。

如果传入该参数，则必须先传入TagFilters.N.Key。

如果不传该参数仅传入TagFilters.N.Key，表示查询同一标签键下的所有标签值。

传入空字符串时，表示查询标签值为空的标签。

如果同一个TagFilters.N.Key传入多个TagFilters.N.Values.N，多个TagFilters.N.Values.N之间的关系为逻辑“或(OR)”。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

RequestId String 示例值：0ED8D006-F706-4D23-88ED-E11ED28D****

请求ID。

PageSize Integer 示例值：20

当前分页的行数。

PageNumber Integer 示例值：1

当前页码。

TotalCount Integer 示例值：1

符合查询条件的SSL服务端的总数。

SslVpnServers Object[] 示例值：-

SSL服务端信息集合。

SslVpnServerId String 示例值：vss-zm55pqtvk17oq32zd****

SSL服务端实例ID

SslVpnServerName String 示例值：test-ssl-vpn

SSL服务端的名称。

VpnGatewayId String 示例值：vgw-12bfa2du17q7y1rk****

SSL服务端使用的VPN网关的ID。

Description String 示例值：This is a descrption

SSL服务端的描述。

Status String 示例值：Available

SSL服务端的状态。

Available：可用

Creating：创建中

Pending：操作中

Deleting：删除中

LocalSubnets String[] 示例值：10.0.0.0/24

SSL服务端的本端网段。

ClientIpPool String 示例值：192.168.1.0/24

SSL客户端网段。

Protocol String 示例值：UDP

SSL服务端所使用的协议，取值：

TCP：TCP协议。

UDP：UDP协议。

Cipher String 示例值：AES-128-CBC

SSL服务端的加密算法。

AES-128-CBC

AES-192-CBC

AES-256-CBC

None （不使用加密）

ClientCertSessionPolicy String 示例值：AllowConcurrent

客户端证书的会话策略。

AllowConcurrent：支持复用。

PreemptExisting：不支持复用。

Auth String 示例值：SHA1

SSL服务端的认证算法。

SHA1

MD5

None（不使用加密）

Compress Boolean 示例值：false

传输数据是否进行压缩处理。

true：数据进行压缩。

false：数据不进行压缩。

CreationTime String 示例值：2023-04-18T15:02:37+08:00

创建SSL服务端的时间。

UpdateTime String 示例值：2023-05-28T18:09:12+08:00

修改SSL服务端的时间。

ProjectName String 示例值：Project_1

SSL服务端所属的项目。

Port Integer 示例值：1194

SSL服务端所使用的端口。

IsBlocked Boolean 示例值：false

当前资源的状态是否被封禁。

true：封禁。

false：未封禁。

Tags Object[] 示例值：-

SSL服务端已添加的全部标签信息。

Key String 示例值：key1

标签键。

Value String 示例值：value1

标签值。

DnsDomain String 示例值：ivolcs.com

DNS解析域。

LogEnabled Boolean 示例值：false

是否开启连接日志。

true：开启。

false：未开启。

SsoAuthEnabled Boolean 示例值：false

是否开启双因子认证。

true：开启。

false：未开启。

DnsServerIpAddresses String[] 示例值：[ "[\"8.8.8.8\"", "\"1.1.1.1\"]" ]

DNS服务器IP。

请求示例

返回示例

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidPage.Malformed	The specified page is malformed.	指定的分页参数不合法。
400	LimitExceeded.SslVpnServerId	You've reached the limit on the number of SSL server IDs that you can describe.	已达到可查询的SSL服务端ID数量上限。
400	InvalidTagFilter.Disorder	The specified index order of tag filter is malformed.	指定标签过滤项的索引顺序参数格式不合法。
400	InvalidTagFilterKey.Malformed	The specified parameter tag filter key is invalid.	过滤标签键不合法。
400	InvalidTagFilterValue.Malformed	The specified parameter tag filter value is invalid.	过滤标签值不合法。
400	LimitExceeded.TagFilterKey	You've reached the limit on the number of tag keys that you can filter.	已达到单次可指定过滤标签键数量的上限。
400	LimitExceeded.TagFilterValue	You've reached the limit on the number of tag values that you can filter.	已达到单次可指定过滤标签值数量的上限。

VPN连接