文档

DoQuickField - 使用快速分析字段进行分析

更新时间:

普通成员登录看到的日志分析页面中,可以通过左侧的快速分析字段进行查询分析。

调试

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

授权信息

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

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

请求参数

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

索引字段。

alert_level
Frominteger

查询分析的开始时间点,Unix 时间戳格式,精确到秒。

1684376244
Tointeger

查询分析的结束时间点,Unix 时间戳格式,精确到秒。

1684378090
Pageinteger

快速分析结果较多时的进行分页,默认为 1。

1
Sizeinteger

快速分析结果较多时每页的展示的数量,默认为 10。

10
Reverseboolean

查询结果排序,默认为降序。

true
RegionIdstring

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

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

返回参数

名称类型描述示例值
object

CloudSiemResponse

Dataobject

快速分析返回的结果。

QueryModeinteger

该参数已废弃,无需关注。

0
Limitedlong

该参数已废弃,无需关注。

0
Countinteger

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

10
HasSQLboolean

该参数已废弃,无需关注。

true
WhereQuerystring

该参数已废弃,无需关注。

* and alert_level : remind | with_pack_meta
PQuerystring

该参数已废弃,无需关注。

""
ProcessedRowslong

本次查询处理的行数。

1000
CompleteOrNotboolean

本次查询是否完成。取值:

  • true:完成
  • false:未完成
true
AggQuerydstring

该参数已废弃,无需关注。

""
Keysarray

该参数已废弃,无需关注。

string

该参数已废弃,无需关注。

""
Logsarray

快速查询获取到的日志。

any

包含了每一行的日志。

[]
RequestIdstring

请求消息 ID。

06735F17-1EDE-5212-81A3-8585368F****

示例

正常返回示例

JSON格式

{
  "Data": {
    "QueryMode": 0,
    "Limited": 0,
    "Count": 10,
    "HasSQL": true,
    "WhereQuery": "* and alert_level : remind | with_pack_meta",
    "PQuery": "\"\"",
    "ProcessedRows": 1000,
    "CompleteOrNot": true,
    "AggQueryd": "\"\"",
    "Keys": [
      "\"\""
    ],
    "Logs": [
      "[]"
    ]
  },
  "RequestId": "06735F17-1EDE-5212-81A3-8585368F****"
}

错误码

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

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

变更历史

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