Method listLogs

Статья создана

Retrieves logs for the specified ClickHouse cluster.

HTTP request

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

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

Parameter	Description
columnFilter	Columns from logs table to request. If no columns are specified, entire log records are returned.
serviceType	Type of the service to request logs about. CLICKHOUSE: Logs of ClickHouse activity.
fromTime	Start timestamp for the logs request, in RFC3339 text format. String in RFC3339 text format.
toTime	End timestamp for the logs request, in RFC3339 text format. String in RFC3339 text format.
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. The maximum value is 1000.
pageToken	Page token. To get the next page of results, set pageToken to the nextPageToken returned by a 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.
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 the `nextRecordToken` from StreamLogs method.