Tencent Cloud

search by keyword

Recent Pages

Documentation

DescribeInstanceLogs

Last updated: 2020-07-10 12:01:59

1. API Description

Domain name for API request: es.tencentcloudapi.com.

This API is used to query the eligible ES cluster logs in the current region.

A maximum of 20 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: es.ap-shanghai-fsi.tencentcloudapi.com

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common parameter. The value used for this API: DescribeInstanceLogs.
Version	Yes	String	Common parameter. The value used for this API: 2018-04-16.
Region	Yes	String	Common parameter. For more information, please see the list of regions supported by the product.
InstanceId	Yes	String	Cluster instance ID
LogType	No	Integer	Log type. Default value: 1 1: master log 2: search slow log 3: index slow log 4: GC log
SearchKey	No	String	Search keyword, which supports LUCENE syntax, such as `level:WARN`, `ip:1.1.1.1`, and `message:test-index`
StartTime	No	String	Log start time in the format of YYYY-MM-DD HH:MM:SS, such as 2019-01-22 20:15:53
EndTime	No	String	Log end time in the format of YYYY-MM-DD HH:MM:SS, such as 2019-01-22 20:15:53
Offset	No	Integer	Pagination start value. Default value: 0
Limit	No	Integer	Number of entries per page. Default value: 100. Maximum value: 100
OrderByType	No	Integer	Time sorting order. Default value: 0 0: descending 1: ascending

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Number of returned logs
InstanceLogList	Array of InstanceLog	Log details list
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying ES cluster logs

This example shows you how to query the latest master logs of a cluster.

Input Example

https://es.tencentcloudapi.com/?Action=DescribeInstanceLogs
&InstanceId=es-f5mwm28u
&<Common request parameters>

Output Example

{
  "Response": {
    "TotalCount": 71633,
    "InstanceLogList": [
      {
        "Time": "2019-01-22T10:45:36.220+08:00",
        "Ip": "10.0.128.65",
        "Level": "INFO",
        "Message": "[o.e.p.o.OPackActionFilter] [1547723102001286009] forbidden request: { ID:cdc62072721547678872c0448c1ecaf9, TYP:MainRequest, USR:null, BRS:false, ACT:cluster:monitor/main, OA:10.0.128.43, IDX:, MET:GET, PTH:/, CNT:<OMITTED, LENGTH=0>, HDR:content-length, EFF:0 } Reason: null"
      },
      {
        "Time": "2019-01-22T10:45:35.730+08:00",
        "Ip": "10.0.128.65",
        "Level": "INFO",
        "Message": "[o.e.p.o.OPackActionFilter] [1547723102001286009] forbidden request: { ID:1a8a5b7ea41a485ebdd769586c1dcdf6, TYP:MainRequest, USR:null, BRS:false, ACT:cluster:monitor/main, OA:10.0.128.73, IDX:, MET:GET, PTH:/, CNT:<OMITTED, LENGTH=0>, HDR:content-length, EFF:0 } Reason: null"
      }
    ],
    "RequestId": "783d9290-dc60-4862-9340-10b632605374"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.