文档

GetLogsV2

更新时间:

查询指定Project下某个Logstore中的原始日志数据,返回结果显示某时间区间中的原始日志。(返回结果压缩后传输)。

  • 日志服务SDK目前仅支持Go、Java、Python三种语言,OpenAPI全部已支持。
  • 使用过程中注意指定压缩方法,不同语言实现的压缩算法不同,详情参考入参Accept-Encoding。
  • 更多相关说明请参见GetLogs

鉴权资源

下表列出了API对应的授权信息。您可以在RAM权限策略语句的Action元素中添加该信息,用于为RAM用户或RAM角色授予调用此API的权限。

动作(Action)

授权策略中的资源描述方式(Resource)

log:GetLogStoreLogs acs:log:{#regionId}:{#accountId}:project/{#ProjectName}

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求头

该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。

名称

类型

是否必选

示例

描述

Accept-Encoding String lz4

压缩方式

  • Java、Python、Go目前仅支持lz4解压缩
  • php、Js、C#目前仅支持gzip解压缩

请求语法

POST /logstores/{logstore}/logs HTTP/1.1

请求参数

名称

类型

位置

是否必选

示例值

描述

project String Host ali-test-project

project 名称。

logstore String Path test-logstore

logstore 名称。

Object Body

请求结构体。

from Integer Body 1627268185

查询开始时间点。该时间是指写入日志数据时指定的日志时间。

请求参数from和to定义的时间区间遵循左闭右开原则,即该时间区间包括区间开始时间点,但不包括区间结束时间点。如果from和to的值相同,则为无效区间,函数直接返回错误。

Unix时间戳格式,表示从1970-1-1 00:00:00 UTC计算起的秒数。

to Integer Body 1627268185

查询结束时间点。该时间是指写入日志数据时指定的日志时间。

请求参数from和to定义的时间区间遵循左闭右开原则,即该时间区间包括区间开始时间点,但不包括区间结束时间点。如果from和to的值相同,则为无效区间,函数直接返回错误。

Unix时间戳格式,表示从1970-1-1 00:00:00 UTC计算起的秒数。

line Long Body 100

仅当query参数为查询语句时,该参数有效,表示请求返回的最大日志条数。最小值为0,最大值为100,默认值为100。

offset Long Body 0

仅当query参数为查询语句时,该参数有效,表示查询开始行。默认值为0。

reverse Boolean Body false

用于指定返回结果是否按日志时间戳降序返回日志,精确到分钟级别。

true:按照日志时间戳降序返回日志。

false(默认值):按照日志时间戳升序返回日志。

注意

当query参数为查询语句时,参数reverse有效,用于指定返回日志排序方式。

当query参数为查询和分析语句时,参数reverse无效,由SQL分析语句中order by语法指定排序方式。如果order by为asc(默认),则为升序;如果order by为desc,则为降序。

powerSql Boolean Body false

是否开启增强sql,默认关闭。

session String Body mode=scan

查询参数

topic String Body ""

日志主题。默认值为双引号("")。

query String Body status: 401 | SELECT remote_addr,COUNT(*) as pv GROUP by remote_addr ORDER by pv desc limit 5

查询语句或者分析语句。更多信息,请参见查询概述和分析概述。

在query参数的分析语句中加上set session parallel_sql=true;,表示使用SQL独享版。例如

  • | set session parallel_sql=true; select count(*) as pv 。

说明当query参数中有分析语句(SQL语句)时,该接口的line参数和offset参数无效,建议设置为0,需通过SQL语句的LIMIT语法实现翻页。更多信息,请参见分页显示查询分析结果。

forward Boolean Body false

scan或短语查询表示是否向前或向后翻页

highlight Boolean Body false

是否高亮

返回数据

名称

类型

示例值

描述

date String Sun, 27 May 2018 08:25:04 GMT

返回响应的时间。

server String nginx

服务器名称。

content-length String 0

响应内容长度。

x-log-requestid String 5B0A6B60BB6EE39764D458B5

服务端产生的标识,该请求的唯一ID。

x-log-bodyrawsize String 120

返回响应内容的大小。

connection String keep-alive

是否长链接。取值包括: close:不是长链接,则每个HTTP请求都会重新建立TCP连接。 keep-alive:长链接,TCP连接建立后保持连接状态,节省连接所需时间和带宽。

content-type String json

返回的响应体的内容格式。

x-log-compresstype String lz4

返回响应内容的压缩格式。

meta Object

返回数据meta信息

progress String Complete

查询的结果是否完整。

  • Complete:查询已经完成,返回结果为完整结果。
  • Incomplete:查询已经完成,返回结果为不完整结果,需要重复请求以获得完整结果。
aggQuery String select *

查询语句中 | 之后的SQL部分

whereQuery String *

查询语句中 | 之前的部分

hasSQL Boolean false

是否sql查询

processedRows Integer 10000

本次查询处理的行数。

elapsedMillisecond Long 5

本次查询消耗的毫秒时间。

cpuSec double 0.002

独享SQL的核时

cpuCores Integer 3

使用cpu核数

keys Array of String key

key

terms Array of Object {term=*, key=}

limited Integer 100

限制条数,sql不带limit会返回

mode Integer 0

查询模式枚举

0: 普通查询(包括sql)

1: 短语查询

2: SCAN扫描

3: SCAN SQL

phraseQueryInfo Object

短语查询

scanAll Boolean true

是否已经扫描了全部日志

beginOffset Long 0

本次扫描结果对应的索引过滤后的起始offset

endOffset Long 0

本次扫描结果对应的索引过滤后的结束offset

endTime Long 1

本次扫描结果对应的索引过滤后的最后时间

scanBytes Long 1024

scan时返回扫描的数据量(字节)。

highlights Array

高亮内容

Array of LogContent

高亮内容

count Integer 1

本次查询请求返回的日志行数。

processedBytes Long 10000

查询处理日志量

isAccurate Boolean true

是否秒级精确

columnTypes Array of String long

类型

telementryType String None

可观测数据类型

data Array of Object

返回的数据。

示例

请求示例

POST /logstores/test-logstore/logs HTTP/1.1
Host:ali-test-project.cn-hangzhou.log.aliyuncs.com
Accept-Encoding:lz4
Content-Type:application/json

{
  "from" : 1703466633,
  "to" : 1703466900,
  "line" : 100,
  "offset" : 0,
  "query" : *
}

正常返回示例

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "headers" : {
    "access-control-allow-origin" : "*",
    "date" : "Wed, 03 Jan 2024 08:25:11 GMT",
    "content-length" : "26120",
    "server" : "AliyunSLS",
    "x-log-requestid" : "659519E708C90EDC*******",
    "x-log-time" : "1704270311",
    "x-log-bodyrawsize" : "106954",
    "connection" : "keep-alive",
    "content-type" : "application/json",
    "x-log-compresstype" : "lz4"
  },
  "statusCode" : 200,
  "body" : {
    "data" : [ {
      "owner_id" : "owner-01",
      "body_bytes_sent" : "2318",
      "request_method" : "GET",
      "http_host" : "www.cc.mock.com",
      "remote_user" : "g1x",
      "upstream_status" : "200",
      "vip_addr" : "101.84.174.246",
      "request_time" : "77",
      "host" : "www.dvn.mock.com",
      "client_ip" : "112.109.215.123"
    } ]
  }
}

错误码

访问错误中心查看更多错误码。

  • 本页导读 (1)