Managed Service for Apache Kafka® API, REST: Cluster.streamLogs
Same as listLogs but using server-side streaming. Also allows for tail -f
semantics.
HTTP request
GET https://mdb.api.cloud.yandex.net/managed-kafka/v1/clusters/{clusterId}:stream_logs
Path parameters
Parameter | Description |
---|---|
clusterId | Required. ID of the Apache Kafka® cluster. 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 logs table to get in the response. If no columns are specified, full log records are returned. |
fromTime | Start timestamp for the logs request. String in RFC3339 text format. The range of possible values is from 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. If this field is not set, all existing logs will be sent and then the new ones as they appear. In essence it has String in RFC3339 text format. The range of possible values is from 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). |
recordToken | Record token. Set recordToken to the The maximum string length in characters is 100. |
filter | A filter expression that filters resources listed in the response. The expression must specify:
Example of a filter: The maximum string length in characters is 1000. |
Response
HTTP Code: 200 - OK
{
"record": {
"timestamp": "string",
"message": "object"
},
"nextRecordToken": "string"
}
Field | Description |
---|---|
record | object One of the requested log records. A single log record. |
record. timestamp |
string (date-time) Log record timestamp. String in RFC3339 text format. The range of possible values is from 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). |
record. message |
object Contents of the log record. |
nextRecordToken | string This token allows you to continue streaming logs starting from the exact same record. To continue streaming, specify value of This value is interchangeable with nextPageToken from ListLogs method. |