Retrieve SSL VPN Server Logs via DescribeVpnSslServerLogs - VPN Gateway - Alibaba Cloud - VPN Gateway

Queries the logs of an SSL server.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

vpc:DescribeVpnSslServerLogs

get

*SslVpnServer

acs:vpc:{#regionId}:{#accountId}:sslvpnserver/{#SslVpnServerId}

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 region ID.	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 start time of the log. Only UNIX timestamps in seconds are supported. For example, 1600738962 represents 2020-09-22 09:42:42. Note If you specify From, you must also specify To or MinutePeriod.	1600738962
To	integer	No	The end time of the log. Only UNIX timestamps in seconds are supported. For example, 1600738962 represents 2020-09-22 09:42:42. Note If you specify To, you must also specify From or MinutePeriod.	1600738962
MinutePeriod	integer	No	The log period. Unit: minutes. Note If you do not specify From or To, you must specify MinutePeriod.	10
PageNumber	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page when using paging. Maximum value: 50. Default value: 10.	10

Response elements

Element	Type	Description	Example
	object	The response parameters.
PageSize	integer	The number of entries per page.	10
PageNumber	integer	The current page number.	1
RequestId	string	The request ID.	DEDAC5B1-9292-5BF7-BDDF-61BA58CFB2FB
Count	integer	The number of log entries.	10
IsCompleted	boolean	Indicates whether the queried logs are accurate. Valid values: true: Accurate. false: Not accurate.	true
Data	object
Logs	array	The array of log entries. Each item in the array is a log entry.
	string	A string array. Each item in the array is a log entry.	"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

Success response

JSON format

{
  "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.
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.