一、1. 接口描述
查询用户该地域下符合条件的ES集群的日志
默认接口请求频率限制:50次/秒。
二、2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
| Action | 是 | String | 公共参数,本接口取值:DescribeInstanceLogs。 |
| Version | 是 | String | 公共参数,本接口取值:2018-04-16。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 集群实例ID示例值:es-xxxxxxxx |
| LogType | 否 | Integer | 日志类型,默认值为11, 主日志2, 搜索慢日志3, 索引慢日志4, GC日志示例值:1 |
| SearchKey | 否 | String | 搜索词,支持LUCENE语法,如 level:WARN、ip:1.1.1.1、message:test-index等示例值:level:INFO OR level:WARN |
| StartTime | 否 | String | 日志开始时间,格式为YYYY-MM-DD HH:MM:SS, 如2019-01-22 20:15:53示例值:2025-03-20 16:05:01 |
| EndTime | 否 | String | 日志结束时间,格式为YYYY-MM-DD HH:MM:SS, 如2019-01-22 20:15:53示例值:2025-03-20 16:06:01 |
| Offset | 否 | Integer | 分页起始值, 默认值为0示例值:1 |
| Limit | 否 | Integer | 分页大小,默认值为100,最大值100示例值:1 |
| OrderByType | 否 | Integer | 时间排序方式,默认值为00, 降序1, 升序示例值:1 |
| LogLevels.N | 否 | Array of String | 日志级别示例值:["INFO"] |
| NodeIds.N | 否 | Array of String | 节点ID示例值:["167890354315"] |
| IndexName | 否 | String | 慢日志索引名示例值:index |
| ShardId | 否 | String | 慢日志索引分片示例值:[index][0] |
| QueryCost | 否 | Integer | 慢日志查询耗时示例值:100 |
三、3. 输出参数
| 参数名称 | 类型 | 描述 |
| TotalCount | Integer | 返回的日志条数示例值:1 |
| InstanceLogList | Array of InstanceLog | 日志详细信息列表 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
四、示例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:cdcxxxabc, 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:1a8axxxabc, 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"
}
}
七、腾讯云 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: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for Ruby: CNB, 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 | 时间相关参数的取值或格式和预期不符。 |
| LimitExceeded.ResponsePackageOversize | 后端服务响应包大小超过配额限制 |
| LimitExceeded.ResponseTimeout | 后端服务响应时间超过配额限制 |
| ResourceNotFound.ClusterInfoNotFound | 集群资源获取失败。 |
| ResourceNotFound.DBInfoNotFound | 数据库资源获取失败。 |