Elasticsearch Service 查询ES集群日志-API 文档-文档中心-腾讯云

1. 接口描述

接口请求域名： es.tencentcloudapi.com 。

查询用户该地域下符合条件的ES集群的日志

默认接口请求频率限制：50次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeInstanceLogs。
Version	是	String	公共参数，本接口取值：2018-04-16。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceId	是	String	集群实例ID
LogType	否	Integer	日志类型，默认值为1 1, 主日志 2, 搜索慢日志 3, 索引慢日志 4, GC日志示例值：1
SearchKey	否	String	搜索词，支持LUCENE语法，如 level:WARN、ip:1.1.1.1、message:test-index等
StartTime	否	String	日志开始时间，格式为YYYY-MM-DD HH:MM:SS, 如2019-01-22 20:15:53
EndTime	否	String	日志结束时间，格式为YYYY-MM-DD HH:MM:SS, 如2019-01-22 20:15:53
Offset	否	Integer	分页起始值, 默认值为0 示例值：1
Limit	否	Integer	分页大小，默认值为100，最大值100 示例值：1
OrderByType	否	Integer	时间排序方式，默认值为0 0, 降序 1, 升序示例值：1

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	返回的日志条数示例值：1
InstanceLogList	Array of InstanceLog	日志详细信息列表
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询ES集群日志

查询实例最新的主日志

输入示例

https://es.tencentcloudapi.com/?Action=DescribeInstanceLogs
&InstanceId=es-f5mwm28u
&<公共请求参数>

输出示例

{
    "Response": {
        "TotalCount": 71633,
        "InstanceLogList": [
            {
                "Time": "2019-01-22T10:45:36.220+08:00",
                "Ip": "10.0.128.65",
                "NodeID": "2131414141414",
                "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",
                "NodeID": "2131414141414",
                "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. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation.RequestTimeOut	请求超时。
InternalError	内部错误。
InvalidParameter.InvalidAppId	AppId的取值和预期不符。
InvalidParameter.InvalidInstanceId	无效的InstanceId，没有找到对应资源。
InvalidParameter.InvalidLimit	分页大小Limit的取值和预期不符。
InvalidParameter.InvalidLogType	日志类型LogType的取值和预期不符。
InvalidParameter.InvalidOffset	分页起始值Offset的取值和预期不符。
InvalidParameter.InvalidOrderByKey	排序字段OrderByKey的取值和预期不符。
InvalidParameter.InvalidQueryString	无效的lucene语法
InvalidParameter.InvalidRegion	地域Region的取值与预期不符。
InvalidParameter.InvalidTimeParam	时间相关参数的取值或格式和预期不符。
ResourceNotFound.ClusterInfoNotFound	集群资源获取失败。
ResourceNotFound.DBInfoNotFound	数据库资源获取失败。

查询ES集群日志

本页目录：