Method listLogs

Retrieves logs for the specified MongoDB cluster. See the Logs section in the developers guide for detailed logs description.

HTTP request

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

Path parameters

Parameter Description
clusterId Required. ID of the MongoDB cluster to request logs for. To get the MongoDB cluster ID use 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, entire log records are returned.
serviceType Type of the service to request logs about.
  • MONGOD: Logs of MongoDB 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 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.

Response

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.