全部产品
Search
文档中心

日志服务:GetProjectLogs

更新时间:Oct 26, 2023

调用GetProjectLogs接口查询目标Project下的日志,该接口是Project级别的SQL查询接口。

接口说明

  • 请求语法中Host由Project名称和日志服务Endpoint构成,您需要在Host中指定Project。
  • 已创建并获取AccessKey。更多信息,请参见访问密钥

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

  • 已明确您查询日志所属的Project名称、所属地域等。如何查询,请参见管理Project
  • 查询日志前,已配置索引。具体操作,请参见创建索引
  • 日志服务查询日志时存在使用限制。请设计合理查询与分析语句、设置合理查询区间等。更多信息,请参见查询日志使用限制分析日志使用限制
  • 参数query是一个标准的SQL查询语句。
  • 查询的Logstore在查询语句的from条件中指定。可以将Logstore看做是SQL中的表。
  • 在查询的SQL条件中必须指定要查询的时间范围,时间范围由__date__(Timestamp类型)或__time__(Integer类型,单位是秒)来指定。

调试

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

请求头

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

请求语法

GET /logs HTTP/1.1

请求参数

名称 类型 位置 是否必选 示例值 描述
project String Host ali-test-project

Project名称。

query String Query SELECT COUNT(*) as pv FROM nginx-moni where __time__ > 1646102500 and __time__ < 1646103400

标准SQL语句。例如日志库名称为nginx-moni,查询时间区间在2022-03-01 10:41:40到2022-03-01 10:56:40之间的访问数量。

powerSql Boolean Query false

是否使用SQL独享版。更多信息,请参见开启SQL独享版

  • true:使用SQL独享版。
  • false(默认值):使用SQL普通版。

除通过powerSql参数配置SQL独享版外,您还可以使用query参数。

返回数据

名称 类型 示例值 描述
x-log-progress String Complete

查询结果的状态,包括:

  • Complete:查询已经完成,返回结果为完整结果。
  • Incomplete:查询已经完成,返回结果为不完整结果,需要重复请求以获得完整结果。
x-log-count Long 10000

当前查询结果的日志总数。

x-log-processed-rows Long 10000

本次查询处理的行数。

x-log-elapsed-millisecond Long 5

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

Server String nginx

服务器名称。

Content-Type String application/json

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

Content-Length String 0

响应内容长度。

Connection String close

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

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

返回响应的时间。

x-log-requestid String 5B0A6B60BB6EE39764D458B5

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

Array of Object [ { "__time__" : 1409529660, "__source__" : "192.168.1.100", "Key1" : "error", "Key2" : "Value2" }, { "__time__" : 1409529680, "__source__" : "192.168.1.100", "Key3" : "error", "Key4" : "Value4" } ]

查询到的日志。

示例

请求示例

GET /logs?query=SELECT COUNT(*) as pv FROM nginx-moni where __time__ > 1646102500 and __time__ < 1646103400&powerSql=false HTTP/1.1
Host:ali-test-project.ch-hangzhou.log.aliyuncs.com
Content-Type:application/json

正常返回示例

JSON格式

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

[ {
  "__time__" : 1409529660,
  "__source__" : "192.168.1.100",
  "Key1" : "error",
  "Key2" : "Value2"
}, {
  "__time__" : 1409529680,
  "__source__" : "192.168.1.100",
  "Key3" : "error",
  "Key4" : "Value4"
} ]

错误码

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

HttpStatusCode

ErrorCode

ErrorMessage

错误码描述

400

ParameterInvalid

Parameter is invalid.

请求的参数错误。

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