Method listLogs
Статья создана
Retrieves logs for the specified Apache Kafka® cluster.
For more information about logs, see the Logs section in the documentation.
HTTP request
GET https://mdb.api.cloud.yandex.net/managed-kafka/v1/clusters/{clusterId}:logs
Path parameters
| Parameter | Description |
|---|---|
| clusterId | Required. ID of the Apache Kafka® cluster to request logs for. To get the Apache Kafka® cluster ID, make a list request. The maximum string length in characters is 50. |
Query parameters
| Parameter | Description |
|---|---|
| columnFilter | Columns from the logs table to request. If no columns are specified, full log records are returned. |
| fromTime | Start timestamp for the logs request. String in RFC3339 text format. |
| toTime | End timestamp for the logs request. 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. |
| alwaysNextPageToken | The flag that defines behavior of providing the next page token. If this flag is set to true, this API method will always return nextPageToken, even if current page is empty. |
| filter | 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. 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}$. Example of a filter: message.hostname='node1.db.cloud.yandex.net' The maximum string length in characters is 1000. |
Response
HTTP Code: 200 - OK
{
"logs": [
{
"timestamp": "string",
"message": "object"
}
],
"nextPageToken": "string"
}
| Field | Description |
|---|---|
| logs[] | object A single log record. |
| logs[]. timestamp |
string (date-time) Log record timestamp. String in RFC3339 text format. |
| logs[]. message |
object Contents of the log record. |
| nextPageToken | string Token that allows you to get the next page of results for list requests. If the number of results is larger than pageSize, use 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 |