Связаться с намиПодключиться

Managed Service for MongoDB API, gRPC: ClusterService.ListLogs

Статья создана
Обновлена 17 октября 2024 г.

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

gRPC request

rpc ListLogs (ListClusterLogsRequest) returns (ListClusterLogsResponse)

ListClusterLogsRequest

{
  "clusterId": "string",
  "columnFilter": [
    "string"
  ],
  "serviceType": "ServiceType",
  "fromTime": "google.protobuf.Timestamp",
  "toTime": "google.protobuf.Timestamp",
  "pageSize": "int64",
  "pageToken": "string"
}

Field

Description

clusterId

string

Required field. ID of the MongoDB cluster to request logs for.
To get the MongoDB cluster ID use a ClusterService.List request.

columnFilter[]

string

Columns from the logs table to request.
If no columns are specified, entire log records are returned.

serviceType

enum ServiceType

Type of the service to request logs about.

  • SERVICE_TYPE_UNSPECIFIED
  • MONGOD: Logs of MongoDB activity.
  • MONGOS
  • MONGOCFG
  • AUDIT: MongoDB Enterprise audit logs

fromTime

google.protobuf.Timestamp

Start timestamp for the logs request, in RFC3339 text format.

toTime

google.protobuf.Timestamp

End timestamp for the logs request, in RFC3339 text format.

pageSize

int64

The maximum number of results per page to return. If the number of available
results is larger than pageSize, the service returns a ListClusterLogsResponse.nextPageToken
that can be used to get the next page of results in subsequent list requests.
Acceptable values are 0 to 1000, inclusive. Default value: 100.

pageToken

string

Page token. To get the next page of results, set pageToken to the
ListClusterLogsResponse.nextPageToken returned by the previous list request.

ListClusterLogsResponse

{
  "logs": [
    {
      "timestamp": "google.protobuf.Timestamp",
      "message": "string"
    }
  ],
  "nextPageToken": "string"
}

Field

Description

logs[]

LogRecord

Requested log records.

nextPageToken

string

This token allows you to get the next page of results for list requests. If the number of results
is larger than ListClusterLogsRequest.pageSize, use the nextPageToken as the value
for the ListClusterLogsRequest.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.

LogRecord

Field

Description

timestamp

google.protobuf.Timestamp

Log record timestamp in RFC3339 text format.

message

string

Contents of the log record.
Предыдущая
RescheduleMaintenance
Следующая
StreamLogs