Managed Service for Elasticsearch API, gRPC: ClusterService.ListLogs
Retrieves logs for the specified Elasticsearch cluster.
For more information about logs, see the Logs section in the documentation.
gRPC request
rpc ListLogs (ListClusterLogsRequest) returns (ListClusterLogsResponse)
ListClusterLogsRequest
{
"clusterId": "string",
"columnFilter": [
"string"
],
"fromTime": "google.protobuf.Timestamp",
"toTime": "google.protobuf.Timestamp",
"pageSize": "int64",
"pageToken": "string",
"alwaysNextPageToken": "bool",
"filter": "string",
"serviceType": "ServiceType"
}
Field |
Description |
clusterId |
string Required field. ID of the Elasticsearch cluster to request logs for. To get the Elasticsearch cluster ID, make a ClusterService.List request. |
columnFilter[] |
string Columns from the logs table to request. If no columns are specified, full log records are returned. |
fromTime |
Start timestamp for the logs request. |
toTime |
End timestamp for the logs request. |
pageSize |
int64 The maximum number of results per page to return. If the number of available results is larger than |
pageToken |
string Page token. To get the next page of results, set |
alwaysNextPageToken |
bool The flag that defines behavior of providing the next page token. If this flag is set to |
filter |
string A filter expression that filters resources listed in the response. The expression must specify:
Example of a filter: |
serviceType |
enum ServiceType Type of the service to request logs about.
|
ListClusterLogsResponse
{
"logs": [
{
"timestamp": "google.protobuf.Timestamp",
"message": "string"
}
],
"nextPageToken": "string"
}
Field |
Description |
logs[] |
Requested log records. |
nextPageToken |
string Token that allows you to get the next page of results for list requests. If the number of results is larger than ListClusterLogsRequest.pageSize, use This value is interchangeable with StreamLogRecord.nextRecordToken from StreamLogs method. |
LogRecord
A single log record.
Field |
Description |
timestamp |
Log record timestamp. |
message |
string Contents of the log record. |