DescribeSslVpnServers--VPN连接-火山引擎

文档中心

立即注册

导航

DescribeSslVpnServers

最近更新时间：2024.09.23 11:00:10首次发布时间：2023.07.28 08:04:08

调用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	List of String	否	SslVpnServerIds.1=vss-12b8vv10jfx8g**&SslVpnServerIds.2=vss-17q7y2yz00zp*	SSL服务端的ID。参数 - N：表示SSL服务端的ID的序号。多个ID之间用&分隔。
PageSize	Integer	否	20	查询结果的分页大小。最大值：100，默认值：20。
PageNumber	Integer	否	1	查询结果的页码。如需传入此参数，请传入非负整数。不传或传入0，则均默认为1。
ProjectName	String	否	Project_1	SSL服务端所属的项目。

返回数据

名称	类型	示例值	描述
RequestId	String	0ED8D006-F706-4D23-88ED-E11ED28D****	请求ID。
PageSize	Integer	20	当前分页的行数。
PageNumber	Integer	1	当前页码。
TotalCount	Integer	1	符合查询条件的SSL服务端的总数。
SslVpnServers	Array of struct	-	SSL服务端信息集合，具体请见下表请参见下方“SslVpnServer”。

SslVpnServer

名称	类型	示例值	描述
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	List	["10.0.0.0/24""172.16.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 （不使用加密）
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：未封禁

请求示例

GET /?Action=DescribeSslVpnServers&Version=2020-04-01&SslVpnServerIds.1=vss-2feyndgkcdbsw59gp68i8**** HTTP/1.1
Host: open.volcengineapi.com
ServiceName: vpn
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202307271951142E39D496F3E4538F****",
        "Action": "DescribeSslVpnServers",
        "Version": "2020-04-01",
        "Service": "vpn",
        "Region": "cn-beijing"
    },
    "Result": {
        "RequestId": "202307271951142E39D496F3E4538F****",
        "PageNumber": 1,
        "PageSize": 1,
        "TotalCount": 1,
        "SslVpnServers": [
            {
                "SslVpnServerId": "vss-2feyndgkcdbsw59gp68i8****",
                "SslVpnServerName": "test-cicd",
                "VpnGatewayId": "vgw-12bjrw3x177y817q7y1oj****",
                "Description": "test",
                "LocalSubnets": [
                    "172.XX.XX.0/16"
                ],
                "ClientIpPool": "172.XX.XX.0/16",
                "Protocol": "UDP",
                "Cipher": "AES-128-CBC",
                "Auth": "SHA1",
                "Compress": false,
                "Status": "Available",
                "Port": 1194,
                "ProjectName": "Project_1",
                "IsBlocked": false,
                "CreationTime": "2023-07-27T19:43:54+08:00",
                "UpdateTime": "2023-07-27T19:47:31+08:00"
            }
        ]
    }
}

错误码

此处仅展示当前API的错误码，更多错误码请参见公共错误码。

HttpCode	错误码	错误信息	描述
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数量上限。