Contact UsGet started

Managed Service for MySQL API, gRPC: ClusterService.ListLogs

Written by
Updated at December 17, 2024

Retrieves logs for a cluster.

Alternatively, logs can be streamed using StreamLogs.

gRPC request

rpc ListLogs (ListClusterLogsRequest) returns (ListClusterLogsResponse)

ListClusterLogsRequest

{
  "cluster_id": "string",
  "column_filter": [
    "string"
  ],
  "service_type": "ServiceType",
  "from_time": "google.protobuf.Timestamp",
  "to_time": "google.protobuf.Timestamp",
  "page_size": "int64",
  "page_token": "string",
  "always_next_page_token": "bool"
}

Field

Description

cluster_id

string

Required field. ID of the cluster to request logs for.

To get this ID, make a ClusterService.List request.

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.

  • SERVICE_TYPE_UNSPECIFIED
  • 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.

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.

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.

ListClusterLogsResponse

{
  "logs": [
    {
      "timestamp": "google.protobuf.Timestamp",
      "message": "map<string, string>"
    }
  ],
  "next_page_token": "string"
}

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.

LogRecord

A single log record.

Field

Description

timestamp

google.protobuf.Timestamp

Timestamp of the log record.

message

object (map<string, string>)

Contents of the log record.
Previous
StartFailover
Next
StreamLogs