Contact UsGet started

Managed Service for Apache Kafka® API, gRPC: ClusterService.ListLogs

Written by
Updated at October 17, 2024

Retrieves logs for the specified Apache Kafka® cluster.

For more information about logs, see the Logs section in the documentation.

gRPC request

rpc ListLogs (ListClusterLogsRequest) returns (ListClusterLogsResponse)

ListClusterLogsRequest

{
  "clusterId": "string",
  "columnFilter": [
    "string"
  ],
  "fromTime": "google.protobuf.Timestamp",
  "toTime": "google.protobuf.Timestamp",
  "pageSize": "int64",
  "pageToken": "string",
  "alwaysNextPageToken": "bool",
  "filter": "string"
}

Field

Description

clusterId

string

Required field. ID of the Apache Kafka® cluster to request logs for.

To get the Apache Kafka® cluster ID, make a ClusterService.List request.

columnFilter[]

string

Columns from the logs table to request.

If no columns are specified, full log records are returned.

fromTime

google.protobuf.Timestamp

Start timestamp for the logs request.

toTime

google.protobuf.Timestamp

End timestamp for the logs request.

pageSize

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.

pageToken

string

Page token.

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

alwaysNextPageToken

bool

The flag that defines behavior of providing the next page token.

If this flag is set to true, this API method will always return ListClusterLogsResponse.nextPageToken, 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 to filter by. Currently filtering can be applied to the hostname field.
  2. An = operator.
  3. The value in double quotes ("). Must be 1-63 characters long and match the regular expression [a-z0-9.-]{1,61}.

Example of a filter: message.hostname='node1.db.cloud.yandex.net'

ListClusterLogsResponse

{
  "logs": [
    {
      "timestamp": "google.protobuf.Timestamp",
      "message": "string"
    }
  ],
  "nextPageToken": "string"
}

Field

Description

logs[]

LogRecord

Requested log records.

nextPageToken

string

Token that allows you to get the next page of results for list requests.

If the number of results is larger than ListClusterLogsRequest.pageSize, use 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 StreamLogRecord.nextRecordToken from StreamLogs method.

LogRecord

A single log record.

Field

Description

timestamp

google.protobuf.Timestamp

Log record timestamp.

message

string

Contents of the log record.
Previous
RescheduleMaintenance
Next
StreamLogs