Managed Service for SPQR API, REST: Cluster.ListLogs

Field

Description

clusterId

string

Required field. ID of the SPQR cluster to request logs for.
To get the SPQR cluster ID use a ClusterService.List request.

Field

Description

columnFilter[]

string

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

serviceType

enum (ServiceType)

Type of the service to request logs about.

• SERVICE_TYPE_UNSPECIFIED
• POSTGRESQL: Logs of SPQR activity.
• ROUTER
• COORDINATOR
• INFRA

fromTime

string (date-time)

Start timestamp for the logs request, in RFC3339 text format.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

toTime

string (date-time)

End timestamp for the logs request, in RFC3339 text format.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

pageSize

string (int64)

The maximum number of results per page to return. If the number of available
results is larger than pageSize, the service returns a ListClusterLogsResponse.nextPageToken
that can be used to get the next page of results in subsequent list requests.
Acceptable values are 0 to 1000, inclusive. Default value: 100.

pageToken

string

Page token. To get the next page of results, set pageToken to the
ListClusterLogsResponse.nextPageToken returned by the previous list request.

alwaysNextPageToken

boolean

Always return next_page_token, even if 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], [LogRecord.logs.message.severity] fields.
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', message.severity IN ('E', 'F')

orderBy

string

Field

Description

logs[]

LogRecord

Requested log records.

nextPageToken

string

This token allows you to get the next page of results for list requests. If the number of results
is larger than ListClusterLogsRequest.pageSize, use the nextPageToken as the value
for the ListClusterLogsRequest.pageToken query parameter in the next list request.
Each subsequent list request will have its own nextPageToken to continue paging through the results.
This value is interchangeable with next_record_token from StreamLogs method.

Field

Description

timestamp

string (date-time)

Log record timestamp in RFC3339 text format.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

message

object (map<string, string>)

Contents of the log record.