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
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 |
| 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 |
| 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. |
This example shows you how to query the latest primary logs of a cluster.
https://es.tencentcloudapi.com/?Action=DescribeInstanceLogs
&InstanceId=es-f5mwm28u
&<Common request parameters>{
"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"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InternalError | Internal error. |
| InvalidParameter | I |