Managed Service for OpenSearch API, REST: Cluster.listLogs
Retrieves logs for the specified OpenSearch cluster.
For detailed description, see the Logs section in the developer's guide.
HTTP request
GET https://mdb.api.cloud.yandex.net/managed-opensearch/v1/clusters/{clusterId}:logs
Path parameters
Parameter | Description |
---|---|
clusterId | Required. ID of the OpenSearch cluster to request logs for. To get the OpenSearch cluster ID use a list request. The maximum string length in characters is 50. |
Query parameters
Parameter | Description |
---|---|
columnFilter | Columns from log table to request. If no columns are specified, entire 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. 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). |
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 the previous list request. The maximum string length in characters is 100. |
alwaysNextPageToken | The service always returns a nextPageToken, even if the current page is empty. |
filter | A filter expression that filters resources listed in the response. The expression must specify:
Examples of a filter:
The maximum string length in characters is 1000. |
serviceType | Type of the service to request logs about.
|
Response
HTTP Code: 200 - OK
{
"logs": [
{
"timestamp": "string",
"message": "object"
}
],
"nextPageToken": "string"
}
Field | Description |
---|---|
logs[] | object Requested log records. |
logs[]. timestamp |
string (date-time) Time when the log was recorded. 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). |
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 has its own nextPageToken to continue paging through the results. This value is interchangeable with the |