ListSearchLog - Elasticsearch

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request headers

This operation uses only common request headers and does not have operation-specific request headers. For more information, see the "Common request parameters" section of the "Common parameters" topic.

Request syntax

GET /openapi/instances/{InstanceId}/search-log HTTP/1.1

Request parameters


Parameter	Type	Position	Required	Example	Description
InstanceId	String	Path	Yes	es-cn-n6w1o1x0w001c****	The ID of the instance.
type	String	Query	Yes	INSTANCELOG	The type of the log. Valid values: INSTANCELOG: the primary log. SEARCHSLOW: searches for slow logs. INDEXINGSLOW: indexing slow logs. JVMLOG: GC logs. ES_SEARCH_ACCESS_LOG: ES access logs. AUDIT: Audit logs. For related restriction information on viewing logs, see Query logs.
query	String	Query	Yes	host:172.16.. AND content:netty	The keyword used to match log entries.
beginTime	Long	Query	No	1531910852074	The beginning of the time range to query. Unit: milliseconds. The value must be within the last seven days. If you do not specify this parameter, all logs within the [Current Time -7 Days, endTime] range are queried.
endTime	Long	Query	No	1531910852074	The end of the time range to query. Unit: milliseconds. The value must be within the last seven days. We recommend that you specify this parameter. If you do not specify this parameter, the returned result is empty.
page	Integer	Query	No	1	The page number of the plug-in list. Pages start from page 1. Default value: 1.
size	Integer	Query	No	20	The number of entries to return on each page. Default value: 20. Minimum value: 1. Maximum value: 50.

Response parameters


Parameter	Type	Example	Description
RequestId	String	7F40EAA1-6F1D-4DD9-8DB8-C5F00C4E****	The ID of the request.
Headers	Object		The header of the response.
X-Total-Count	Integer	1000	The number of entries returned per page.
Result	Array of Result		The list of logs returned by the request.
level	String	info	The level of the log. Valid values: warn: warning log info: information log error: error log trace: trace logs debug: debug logs The level information has been migrated to the contentCollection field.
host	String	192.168..	The IP address of the node that generates the log.
content	String	[GC (Allocation Failure) 2018-07-19T17:24:20.682+0800: 7516.513: [ParNew: 6604768K->81121K(7341504K), 0.0760606 secs] 7226662K->703015K(31813056K), 0.0762507 secs] [Times: user=0.52 sys=0.00, real=0.07 secs]	The content of the log entry. Migrated to the contentCollection field.
timestamp	Long	1531985112420	The timestamp when the log is generated. Unit: ms.
contentCollection	Map		Details of the log entry. Different content fields are returned for different log types.
instanceId	String	es-cn-n6w1o1x0w001c****	The ID of the instance.

The Result.contentCollection contains the following parameters.


Parameter	Type	Example	Description
time	String	2020-07-21T11:12:53.057Z	The time when the log entry was generated.
content	String	[o.e.c.r.a.AllocationService] [MnNASM_] Cluster health status changed from [YELLOW] to [GREEN] (reason: [shards started [[my_index][3]] ...]).	The content of the log entry.
host	String	192.168..	The IP address of the node that generates the log.
level	String	warn	The level of the log. Valid values: warn, info, error log, trace, and debug.

Examples

Sample requests

GET /openapi/instances/es-cn-n6w1o1x0w001c****/search-log?type=INSTANCELOG&query=host:172.16.**.** AND content:netty&beginTime=1531910852074&endTime=1531910852074&page=1&size=20 HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json

Sample success responses

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Result" : [ {
    "timestamp" : 1552868172741,
    "host" : "192.168.**.**",
    "contentCollection" : {
      "level" : "info",
      "host" : "192.168.**.**",
      "time" : "2019-03-18T08:16:12.741Z",
      "content" : "[o.e.c.r.a.AllocationService] [MnNASM_] Cluster health status changed from [YELLOW] to [GREEN] (reason: [shards started [[my_index][3]] ...])."
    },
    "instanceId" : "es-cn-n6w1o1x0w001c****"
  }, {
    "timestamp" : 1552838205462,
    "host" : "192.168.**.**",
    "contentCollection" : {
      "level" : "info",
      "host" : "192.168.**.**",
      "time" : "2019-03-17T23:56:45.462Z",
      "content" : "[o.e.c.r.a.AllocationService] [v4p9o7A] Cluster health status changed from [GREEN] to [YELLOW] (reason: [{MnNASM_}{MnNASM_OSR-2YgySSc****}{EvJHPrAOS_u8J3-6qZ****}{192.168.**.**}{192.168.**.**:9300}{ml.max_open_jobs=10, ml.enabled=true} transport disconnected])."
    },
    "instanceId" : "es-cn-n6w1o1x0w001c****"
  } ],
  "RequestId" : "121753D9-744A-4203-9EC4-F29E628A****",
  "Headers" : {
    "X-Total-Count" : 2
  }
}

Error codes

For a list of error codes, visit the API Error Center.