Managed Service for Redis API, REST: Cluster.listLogs

Written by

improved by

Retrieves logs for the specified Redis cluster.

HTTP request

GET https://mdb.api.cloud.yandex.net/managed-redis/v1/clusters/{clusterId}:logs

Parameter	Description
clusterId	Required. ID of the Redis cluster to request logs for. To get the Redis cluster ID use a list request. The maximum string length in characters is 50.

Parameter

Description

clusterId

Required. ID of the Redis cluster to request logs for. To get the Redis cluster ID use a list request.

The maximum string length in characters is 50.

Parameter	Description
columnFilter	Columns from the logs table to request. If no columns are specified, entire log records are returned.
serviceType	REDIS: Logs of Redis activity.
fromTime	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	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	The maximum number of results per page to return. If the number of available results is larger than pageSize, the service returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 1000, inclusive.
pageToken	Page token. To get the next page of results, set pageToken to the nextPageToken returned by the previous list request. The maximum string length in characters is 100.

HTTP Code: 200 - OK

{
  "logs": [
    {
      "timestamp": "string",
      "message": "object"
    }
  ],
  "nextPageToken": "string"
}

Field	Description
logs[]	object Requested log records.
logs[]. 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).
logs[]. message	object Contents of the log record.
nextPageToken	string This token allows you to get the next page of results for list requests. If the number of results is larger than pageSize, use the nextPageToken as the value for the 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.