DescribeSslVpnServers - VPN Gateway

Queries one or more SSL-VPN servers.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
vpc:DescribeSslVpnServers	list	SslVpnServer acs:vpc:{#regionId}:{#accountId}:sslvpnserver/* SslVpnServer acs:vpc:{#regionId}:{#accountId}:sslvpnserver/{#SslVpnServerId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the SSL server. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
SslVpnServerId	string	No	The ID of the SSL server.	vss-bp15j3du13gq1dgey****
VpnGatewayId	string	No	The ID of the VPN gateway.	vpn-bp1on0xae9d771ggi****
Name	string	No	The SSL server name. The name must be 1 to 100 characters in length and cannot start with `http://` or `https://`.	test
PageNumber	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Maximum value: 50. Default value: 10.	10
ResourceGroupId	string	No	The ID of the resource group to which the SSL server belongs. The SSL server has the same resource group as its associated VPN gateway instance. You can call the DescribeVpnGateway operation to query the ID of the resource group to which the VPN gateway instance belongs.	rg-acfmzs372yg****

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
PageSize	integer	The number of entries per page.	10
RequestId	string	The request ID.	D350187B-EA41-4577-950B-95434C8302E1
PageNumber	integer	The number of the page to return.	1
TotalCount	integer	The number of entries returned.	1
SslVpnServers	array<object>	The detailed information about the SSL-VPN server.
SslVpnServer	object
InternetIp	string	The public IP address of the VPN gateway.	47.5.XX.XX
IDaaSInstanceId	string	The ID of the IDaaS instance.	idaas-cn-hangzhou-****
CreateTime	long	The timestamp generated when the SSL-VPN server was created.	1613800884000
VpnGatewayId	string	The ID of the VPN gateway.	vpn-bp1on0xae9d771ggi****
IDaaSRegionId	string	The region ID of the IDaaS instance.	cn-hangzhou
Compress	boolean	Indicates whether data compression is enabled. Valid values: true false (default)	false
Port	integer	The port that is used by the SSL-VPN server.	1194
LocalSubnet	string	The local CIDR block.	192.168.0.0/24
RegionId	string	The region ID of the SSL-VPN server.	cn-hangzhou
Cipher	string	The encryption algorithm.	AES-128-CBC
Connections	integer	The total number of current connections.	0
SslVpnServerId	string	The ID of the SSL-VPN server.	vss-bp15j3du13gq1dgey****
MaxConnections	integer	The maximum number of connections.	5
Name	string	The name of the SSL-VPN server.	test
EnableMultiFactorAuth	boolean	Indicates whether two-factor authentication is enabled. true false (default)	true
ClientIpPool	string	The client CIDR block.	10.10.1.0/24
Proto	string	The protocol that is used by the SSL-VPN server.	UDP
ResourceGroupId	string	The resource group ID of the SSL-VPN server. You can call the ListResourceGroups operation to query resource groups.	rg-acfmzs372yg****

Examples

Sample success responses

JSONformat

{
  "PageSize": 10,
  "RequestId": "D350187B-EA41-4577-950B-95434C8302E1",
  "PageNumber": 1,
  "TotalCount": 1,
  "SslVpnServers": {
    "SslVpnServer": [
      {
        "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",
        "ResourceGroupId": "rg-acfmzs372yg****",
        "IDaaSApplicationId": "app_my6g4qmvnwxzj2f****",
        "IDaaSInstanceVersion": "EIAM 2.0"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
403	Forbbiden.SubUser	User not authorized to operate on the specified resource as your account is created by another user.	You are unauthorized to perform this operation on the specified resource. Acquire the required permissions and try again.
403	Forbidden	User not authorized to operate on the specified resource.	You do not have the permissions to manage the specified resource. Apply for the permissions and try again.
404	InvalidRegionId.NotFound	The specified region is not found during access authentication.	The specified area is not found during authentication.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-05-10	The Error code has changed. The response structure of the API has changed	View Change Details
2023-10-19	API Description Update. The API operation is not deprecated.. The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed	View Change Details