Managed Service for MySQL API, gRPC: ClusterService.ListLogs

Field

Description

cluster_id

string

Required field. ID of the cluster to request logs for.
To get this ID, make a ClusterService.List request.

The maximum string length in characters is 50.

column_filter[]

string

Columns from the logs table to request.
If no columns are specified, complete log records are returned.

service_type

enum ServiceType

The log type.

• MYSQL_ERROR: MySQL error log.
• MYSQL_GENERAL: MySQL general query log.
• MYSQL_SLOW_QUERY: MySQL slow query log.
• MYSQL_AUDIT: MySQL audit log.

from_time

google.protobuf.Timestamp

Start timestamp for the logs request.
The logs in the response will be within from_time to to_time range.

to_time

google.protobuf.Timestamp

End timestamp for the logs request.
The logs in the response will be within from_time to to_time range.

page_size

int64

The maximum number of results per page to return.
If the number of available results is larger than page_size, the API returns a ListClusterLogsResponse.next_page_token that can be used to get the next page of results in the subsequent ClusterService.ListLogs requests.

Acceptable values are 0 to 1000, inclusive.

page_token

string

Page token that can be used to iterate through multiple pages of results.
To get the next page of results, set page_token to the ListClusterLogsResponse.next_page_token returned by the previous ClusterService.ListLogs request.

The maximum string length in characters is 100.

always_next_page_token

bool

Option that controls the behavior of result pagination.
If it is set to true, then ListClusterLogsResponse.next_page_token will always be returned, even if the current page is empty.

filter

string

A filter expression that filters resources listed in the response.
The expression must specify:

1. The field name. Currently filtering can be applied to the [LogRecord.logs.message.hostname] field.
2. A conditional operator. Can be either = or != for single values, IN or NOT IN for lists of values.
3. The value. Must be 1-63 characters long and match the regular expression ^[a-z0-9.-]{1,61}$.
   Examples of a filter: message.hostname='node1.db.cloud.yandex.net'

The maximum string length in characters is 1000.

order_by

string

Order by specification as a JSON array of {field, order} objects.
Supported fields: TIMESTAMP. Supported orders: ASC, DESC.
Example: [{"field": "TIMESTAMP", "order": "DESC"}]

Field

Description

logs[]

LogRecord

Requested log records.

next_page_token

string

The token that can be used to get the next page of results.
If the number of results is larger than ListClusterLogsRequest.page_size, use the next_page_token as the value for the ListClusterLogsRequest.page_token in the subsequent ClusterService.ListLogs request to iterate through multiple pages of results.
Each of the subsequent ClusterService.ListLogs requests should use the next_page_token value returned by the previous request to continue paging through the results.
This value is interchangeable with StreamLogRecord.next_record_token from ClusterService.StreamLogs method.

Field

Description

timestamp

google.protobuf.Timestamp

Timestamp of the log record.

message

object (map<string, string>)

Contents of the log record.