Queries the log entries of an SSL server.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | 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 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 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 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.
|
To | Integer | No | 1600738962 |
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.
|
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 | 10 |
The number of entries returned per page. |
PageNumber | Integer | 1 |
The page number of the returned page. |
RequestId | String | DEDAC5B1-9292-5BF7-BDDF-61BA58CFB2FB |
The ID of the request. |
Count | Integer | 10 |
The number of log entries. |
IsCompleted | Boolean | true |
Indicates whether the log is accurate. Valid values:
|
Data | Array of 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****" ] |
An array of strings. Each item in the array is a log entry. |
Examples
Sample requests
http(s)://[Endpoint]/?Action=DescribeVpnSslServerLogs
&RegionId=cn-hangzhou
&VpnSslServerId=vss-bp155e9yclsg1xgq4****
&SslVpnClientCertId=vsc-m5euof6s5jy8vs5kd****
&From=1600738962
&To=1600738962
&MinutePeriod=10
&PageNumber=1
&PageSize=10
&Common request parameters
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeVpnSslServerLogsResponse>
<PageSize>10</PageSize>
<RequestId>DEDAC5B1-9292-5BF7-BDDF-61BA58CFB2FB</RequestId>
<PageNumber>1</PageNumber>
<IsCompleted>true</IsCompleted>
<Data>
<Logs>Mon Feb 28 14:05:51 2022 us=421630 MULTI: multi_create_instance called</Logs>
<Logs>Mon Feb 28 14:05:51 2022 us=421744 112.XX.XX.128:42522 Re-using SSL/TLS context</Logs>
<Logs>Mon Feb 28 14:05:51 2022 us=421834 112.XX.XX.128:42522 Control Channel MTU par****</Logs>
<Logs>Mon Feb 28 14:05:51 2022 us=421850 112.XX.XX.128:42522 Data Channel MTU par****</Logs>
<Logs>Mon Feb 28 14:05:51 2022 us=421901 112.XX.XX.128:42522 Local Option****</Logs>
<Logs>Mon Feb 28 14:05:51 2022 us=421917 112.XX.XX.128:42522 Expected Remote Option****</Logs>
<Logs>Mon Feb 28 14:05:51 2022 us=421951 112.XX.XX.128:42522 TLS: Initial packet from****</Logs>
<Logs>Mon Feb 28 14:05:51 2022 us=581413 112.XX.XX.128:42522 VERIFY OK****</Logs>
<Logs>Mon Feb 28 14:05:51 2022 us=581662 112.XX.XX.128:42522 VERIFY OK****</Logs>
<Logs>Mon Feb 28 14:05:51 2022 us=621071 112.XX.XX.128:42522 peer info****</Logs>
</Data>
<Count>10</Count>
</DescribeVpnSslServerLogsResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"PageSize" : 10,
"RequestId" : "DEDAC5B1-9292-5BF7-BDDF-61BA58CFB2FB",
"PageNumber" : 1,
"IsCompleted" : true,
"Data" : {
"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****" ]
},
"Count" : 10
}
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 not authorized to perform the operation on the specified resource. Acquire the required permissions and try again. |
For a list of error codes, visit the API Error Center.