有奖捉虫:行业应用 & 管理与支持文档专题 HOT

1. 接口描述

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

查询用户该地域下符合条件的Logstash实例的日志

默认接口请求频率限制:20次/秒。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeLogstashInstanceLogs。
Version String 公共参数,本接口取值:2018-04-16。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 实例ID
示例值:ls-xxxxxxxx
LogType Integer 日志类型,默认值为1
  • 1, 主日志
  • 2, 慢日志
  • 3, 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
    示例值:2019-01-22 20:15:53
    EndTime String 日志结束时间,格式为YYYY-MM-DD HH:MM:SS, 如2019-01-22 20:15:53
    示例值:2019-01-22 21:15:53
    Offset Integer 分页起始值, 默认值为0
    示例值:0
    Limit Integer 分页大小,默认值为100,最大值100
    示例值:10
    OrderByType Integer 时间排序方式,默认值为0
  • 0, 降序
  • 1, 升序

  • 示例值:1

    3. 输出参数

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

    4. 示例

    示例1 获取Logstash实例日志

    输入示例

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

    输出示例

    {
        "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. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InternalError 内部错误。
    InvalidParameter 参数错误。