文档

GetLogs - 获取威胁分析查询分析的日志数据

更新时间:

返回日志分析中查询分析SQL语句执行的结果。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-sas:GetLogsRead
  • acs:yundun-sas::{#accountId}:*

请求参数

名称类型必填描述示例值
Querystring

查询语句或者分析语句。更多信息,请参见日志服务查询概述分析概述

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

查询的开始时间点。UNIX 时间戳格式,表示从 1970-1-1 00:00:00 UTC 计算起的秒数。

1684377190
Tointeger

查询的结束时间点。UNIX 时间戳格式,表示从 1970-1-1 00:00:00 UTC 计算起的秒数。

1684378326
PageSizeinteger

查询分析时,每页显示结果行数,取值范围为 0-100。

10
PageIndexinteger

查询分析时,当前的查询页数,从 1 开始。

1
Totallong

根据查询条件查询出的总数量。

2
ReverseOrNotboolean

查询语句时,是否结果按照时间(分钟级别)降序排列,默认为 true。取值:

  • true:降序
  • false:升序
true
RegionIdstring

威胁分析的数据管理中心所在地。您需要根据资产所在地域,选择管理中心所在地。取值:

  • cn-hangzhou:资产属于中国内地与中国香港,选择该项。
  • ap-southeast-1:资产属于海外地域,选择该项。
cn-hangzhou

返回参数

名称类型描述示例值
object

PageResponse

Successboolean

请求是否成功,取值:

  • true:成功
  • false:失败
True
Codeinteger

HTTP 状态码。

200
Messagestring

请求返回消息。

success
RequestIdstring

请求 ID。

93A8B186-A5F1-5B20-9BCF-5605C5E9****
Dataobject

查询分析的结果。

PageInfoobject

当前页加载的数据内容。

CurrentPageinteger

当前页数,从 1 开始。

1
PageSizeinteger

每页返回记录数。

20
TotalCountlong

日志总数。

200
ResponseDataobject

日志内容。

CompleteOrNotboolean

整体查询结果的状态,取值:

  • true:本次查询已经完成,整体返回结果为完整结果
  • false:本次查询已经完成,整体返回结果为不完整结果,需要重复请求以获得完整结果
true
Countinteger

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

4
Costlong

本次查询消耗的毫秒数。

28
HasSqlboolean

是否包含分析语句,取值:

  • true:包含
  • false:不包含
true
Keysarray

日志索引字段列表。

string

索引字段。

__topic__
Linesarray

本次查询产生的原始数据。

any

一行原始数据。

alert_level: suspicious alert_name: login_common_ip alert_name_code: security_event_config.event_name.ilp alert_name_en: Login with unusual IP alert_src_prod: sas alert_src_prod_module: aegis_login_log alert_title_en: Unusual Logon-Login with unusual IP

示例

正常返回示例

JSON格式

{
  "Success": true,
  "Code": 200,
  "Message": "success",
  "RequestId": "93A8B186-A5F1-5B20-9BCF-5605C5E9****",
  "Data": {
    "PageInfo": {
      "CurrentPage": 1,
      "PageSize": 20,
      "TotalCount": 200
    },
    "ResponseData": {
      "CompleteOrNot": true,
      "Count": 4,
      "Cost": 28,
      "HasSql": true,
      "Keys": [
        "__topic__"
      ],
      "Lines": [
        "alert_level: suspicious\nalert_name: login_common_ip\nalert_name_code: security_event_config.event_name.ilp\nalert_name_en: Login with unusual IP\nalert_src_prod: sas\nalert_src_prod_module: aegis_login_log\nalert_title_en: Unusual Logon-Login with unusual IP"
      ]
    }
  }
}

错误码

HTTP status code错误码错误信息描述
400Siem.Analysis.IllegalParameterStart time should less than or equal to end time.日志查询的开始时间不能小于结束时间。
400Siem.Analysis.SQLErrorAnalysis SQL is error.查询分析的SQL语句存在语法错误。
500InternalErrorThe request processing has failed due to some unknown error.服务发生某些未知错误,请稍后再试

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

变更历史

变更时间变更内容概要操作
2023-12-13OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:501
    新增错误码:500
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)