GetLogs

接口说明

• 请求语法中Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。

• 已创建并获取AccessKey。更多信息，请参见访问密钥。

  阿里云账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。RAM用户需具备操作日志服务资源的权限。具体操作，请参见创建RAM用户及授权。

• 已明确您查询日志所属的Project名称、所属地域、Logstore名称等。如何查询，请参见管理Project和管理Logstore。
• 日志服务查询日志时存在使用限制。请设计合理查询与分析语句、设置合理查询区间等。更多信息，请参见查询日志使用限制和分析日志使用限制。
• 查询日志前，已配置索引。具体操作，请参见创建索引。
• 当查询涉及的日志数量变化非常大时，日志服务API无法预测需要调用多少次该接口来获取完整结果。所以需要您查看每次请求返回结果中的x-log-progress状态值，根据状态值来确定是否需要重复调用该接口来获取最终完整结果。每次重复调用该接口都会重新消耗相同数量的查询CU。
• 当日志写入到Logstore中，日志服务的查询接口（GetHistograms和GetLogs）能够查到该日志的延时因写入日志类型不同而异。日志服务按日志时间戳把日志分为如下两类：
  • 实时数据：日志中时间点为服务器当前时间点(-180秒，900秒]。例如，日志时间为UTC 2014-09-25 12:03:00，服务器收到时为UTC 2014-09-25 12:05:00，则该日志被作为实时数据处理，一般出现在正常场景下。

  • 历史数据：日志中时间点为服务器当前时间点[-7x86400秒，-180秒）。例如，日志时间为UTC 2014-09-25 12:00:00，服务器收到时为UTC 2014-09-25 12:05:00，则该日志被作为历史数据处理，一般出现在补数据场景下。

    其中，实时数据写入至可查询的最大延时为3秒，99.9%情况下1秒内即可查询完毕。

• 日志服务提供Java和Python SDK的GetLogs查询使用示例。更多信息，请参见Java GetLogs使用示例和Python GetLogs使用示例。

鉴权资源

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

请求头

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

请求语法

GET /logstores/{logstore}?type=log HTTP/1.1

请求参数

返回数据

示例

请求示例

GET /logstores/{logstore}?type=log&from=1627268185&to=1627269085&query=status: 401 | SELECT remote_addr,COUNT(*) as pv GROUP by remote_addr ORDER by pv desc limit 5&topic=topic&line=100&offset=0&reverse=false&powerSql=false HTTP/1.1
Host:ali-test-project.cn-hangzhou.log.aliyuncs.com
Content-Type:application/json

请求示例补充说明

### 原始日志示例
```json
    {
    	"remote_addr": "203.0.*.*",
    	"__time__": 1649904328,
    	"__topic__": "nginx_access_log",
    	"__source__": "127.0.0.1",
    	"body_bytes_sent": "3841",
    	"__tag__:__receive_time__": "1649904334",
    	"time_local": "14/Apr/2022:02:45:28",
    	"request_method": "HEAD",
    	"request_uri": "/request/path-2/file-2",
    	"http_user_agent": "Mozilla/5.0 (Windows NT 6.2; Win64; x64; rv:21.0.0) Gecko/20121011 Firefox/21.0.0",
    	"remote_user": "jlqd8",
    	"request_time": "17",
    	"__pack_meta__": "1|MTYyODY2Mjk0NzQ1ODU1Mjk4Mg==|197|165",
    	"request_length": "4184",
    	"http_referer": "www.example.com",
    	"__tag__:__receive_time___0": "1649904334",
    	"host": "www.example.com",
    	"http_x_forwarded_for": "198.51.100.48",
    	"upstream_response_time": "0.23",
    	"status": "401"
    }
```

正常返回示例

JSON格式

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

{
  "x-log-progress" : "Complete",
  "x-log-count" : 5,
  "logs" : "[{'remote_addr': '198.51.XXX.XXX', 'pv': '1', '__source__': '', '__time__': '1649902984'}, {'remote_addr': '198.51.XXX.XXX', 'pv': '1', '__source__': '', '__time__': '1649902984'}, {'remote_addr': '198.51.XXX.XXX', 'pv': '1', '__source__': '', '__time__': '1649902984'}, {'remote_addr': '198.51.XXX.XXX', 'pv': '1', '__source__': '', '__time__': '1649902984'}, {'remote_addr': '198.51.100.XXX', 'pv': '1', '__source__': '', '__time__': '1649902984'}]"
}

错误码

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

更多信息，请参见通用错误码。