Queries the log of an SSL-VPN server.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String No DescribeVpnSslServerLogs

The operation that you want to perform.

Set the value to DescribeVpnSslServerLogs.

RegionId String Yes cn-hangzhou

The ID of the region where the SSL-VPN server is created. You can call the DescribeRegions operation to query the most recent region list.

VpnSslServerId String Yes vss-bp155e9yclsg1xgq4****

The ID of the SSL-VPN server.

SslVpnClientCertId String No vsc-m5euof6s5jy8vs5kd****

The ID of the SSL client certificate.

From Integer No 1600738962

The beginning of the time range to query. The value must be a UTC timestamp that is accurate to seconds. For example, 1600738962 indicates 09:42:42 (UTC) on September 22, 2020.

Note If you specify From, you must also specify To or MinutePeriod.
To Integer No 1600738962

The end of the time range to query. The value must be a UTC timestamp that is accurate to seconds. For example, 1600738962 indicates 09:42:42 (UTC) on September 22, 2020.

Note If you specify To, you must also specify From or MinutePeriod.
MinutePeriod Integer No 10

The interval at which log data is queried. Unit: minutes.

Note If both From and To are not specified, you must specify MinutePeriod.
PageNumber Integer No 1

The number of the page to return. Default value: 1.

PageSize Integer No 10

The number of entries to return on each page. Maximum value: 50. Default value: 10.

Response parameters

Parameter Type Example Description
PageSize Integer 1

The number of entries returned per page.

PageNumber Integer 1

The number of the returned page.

RequestId String 5BE01CD7-5A50-472D-AC14-CA181C5C03BE

The ID of the request.

Count Integer 10

The number of log entries.

IsCompleted Boolean true

Indicates whether the log data is accurate. Valid values:

  • true: accurate
  • false: inaccurate
Data Array of String "date": "Mon, 25 Oct 2021 08:53:11 GMT"

An array of log entries. Each item in the array indicates a log entry.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeVpnSslServerLogs
&RegionId=cn-hangzhou
&VpnSslServerId=vss-bp155e9yclsg1xgq4****
&From=1600738962
&To=1600738962
&MinutePeriod=10
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeVpnSslServerLogsResponse>
    <PageSize>1</PageSize>
    <PageNumber>1</PageNumber>
    <RequestId>5BE01CD7-5A50-472D-AC14-CA181C5C03BE</RequestId>
    <Count>10</Count>
    <IsCompleted>true</IsCompleted>
    <Data>"date": "Mon, 25 Oct 2021 08:53:11 GMT"</Data>
</DescribeVpnSslServerLogsResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "PageSize" : 1,
  "PageNumber" : 1,
  "RequestId" : "5BE01CD7-5A50-472D-AC14-CA181C5C03BE",
  "Count" : 10,
  "IsCompleted" : true,
  "Data" : [ "\"date\": \"Mon, 25 Oct 2021 08:53:11 GMT\"" ]
}

Error codes

HttpCode 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. The error message returned because you are unauthorized to perform this operation on the specified resource. Apply for the required permissions and try again.
403 Forbidden User not authorized to operate on the specified resource. The error message returned because you are unauthorized to perform this operation on the specified resource. To acquire the required permissions, submit a ticket.

For a list of error codes, visit the API Error Center.