DescribeVpnSslServerLogs - VPN Gateway

Queries the log entries of an SSL server.

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:DescribeVpnSslServerLogs	get	SslVpnServer acs:vpc:{#regionId}:{#accountId}:sslvpnserver/{#SslVpnServerId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the SSL server is created. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
VpnSslServerId	string	Yes	The ID of the SSL server.	vss-bp155e9yclsg1xgq4****
SslVpnClientCertId	string	No	The ID of the SSL client certificate.	vsc-m5euof6s5jy8vs5kd****
From	integer	No	The beginning of the time range to query. The value must be a unix timestamp. For example, 1600738962 specifies 09:42:42 (UTC+8) on September 22, 2020. Note If you specify From, you must also specify To or MinutePeriod.	1600738962
To	integer	No	The end of the time range to query. The value must be a unix timestamp. For example, 1600738962 specifies 09:42:42 (UTC+8) on September 22, 2020. Note If you specify To, you must also specify From or MinutePeriod.	1600738962
MinutePeriod	integer	No	The interval at which log data is queried. Unit: minutes. Note If both From and To are not specified, you must specify MinutePeriod.	10
PageNumber	integer	No	The number of the page to return. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Maximum value: 50. Default value: 10.	10

Response parameters

Parameter	Type	Description	Example
	object
PageSize	integer	The number of entries returned per page.	10
PageNumber	integer	The page number of the returned page.	1
RequestId	string	The ID of the request.	DEDAC5B1-9292-5BF7-BDDF-61BA58CFB2FB
Count	integer	The number of log entries.	10
IsCompleted	boolean	Indicates whether the log is accurate. Valid values: true: accurate false: inaccurate	true
Data	array	An array of strings. Each item in the array is a log entry.
Logs	string		"Logs": [ "Mon Feb 28 14:05:51 2022 us=421630 MULTI: multi_create_instance called", "Mon Feb 28 14:05:51 2022 us=421744 112.XX.XX.128:42522 Re-using SSL/TLS context", "Mon Feb 28 14:05:51 2022 us=421834 112.XX.XX.128:42522 Control Channel MTU par**", "Mon Feb 28 14:05:51 2022 us=421850 112.XX.XX.128:42522 Data Channel MTU par", "Mon Feb 28 14:05:51 2022 us=421901 112.XX.XX.128:42522 Local Option", "Mon Feb 28 14:05:51 2022 us=421917 112.XX.XX.128:42522 Expected Remote Option", "Mon Feb 28 14:05:51 2022 us=421951 112.XX.XX.128:42522 TLS: Initial packet from", "Mon Feb 28 14:05:51 2022 us=581413 112.XX.XX.128:42522 VERIFY OK", "Mon Feb 28 14:05:51 2022 us=581662 112.XX.XX.128:42522 VERIFY OK", "Mon Feb 28 14:05:51 2022 us=621071 112.XX.XX.128:42522 peer info**" ]

Examples

Sample success responses

JSONformat

{
  "PageSize": 10,
  "PageNumber": 1,
  "RequestId": "DEDAC5B1-9292-5BF7-BDDF-61BA58CFB2FB",
  "Count": 10,
  "IsCompleted": true,
  "Data": {
    "Logs": [
      "\"Logs\": [ \"Mon Feb 28 14:05:51 2022 us=421630 MULTI: multi_create_instance called\", \"Mon Feb 28 14:05:51 2022 us=421744 112.XX.XX.128:42522 Re-using SSL/TLS context\", \"Mon Feb 28 14:05:51 2022 us=421834 112.XX.XX.128:42522 Control Channel MTU par****\", \"Mon Feb 28 14:05:51 2022 us=421850 112.XX.XX.128:42522 Data Channel MTU par****\", \"Mon Feb 28 14:05:51 2022 us=421901 112.XX.XX.128:42522 Local Option****\", \"Mon Feb 28 14:05:51 2022 us=421917 112.XX.XX.128:42522 Expected Remote Option****\", \"Mon Feb 28 14:05:51 2022 us=421951 112.XX.XX.128:42522 TLS: Initial packet from****\", \"Mon Feb 28 14:05:51 2022 us=581413 112.XX.XX.128:42522 VERIFY OK****\", \"Mon Feb 28 14:05:51 2022 us=581662 112.XX.XX.128:42522 VERIFY OK****\", \"Mon Feb 28 14:05:51 2022 us=621071 112.XX.XX.128:42522 peer info****\" ]"
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidSslVpnClientCertId.NotFound	The specified SSL VPN client id does not exist.	-
400	ParamExclusive.SslVpnServerIdAndSslVpnClientCertId	The specified SSL VPN client does not belong to the specified SSL VPN server.	-
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	InvalidSslVpnServerId.NotFound	The specified SSL VPN server id does not exist.	-

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