文档

GetHistograms - 获取威胁分析日志查询分析结果的直方图数据

更新时间:

返回查询分析SQL执行结果的数据直方图数据,可以用来在前端渲染直方图展示。

调试

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

授权信息

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

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

请求参数

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

查询语句。仅支持查询语句,不支持分析语句。关于查询语句的详细语法和使用限制,请参日志服务的见查询概述

* and status: 401
Frominteger

子时间区间的开始时间点。UNIX 时间戳格式,表示从 1970-1-1 00:00:00 UTC 计算起的秒数。时间区间遵循“左闭右开”原则,即该时间区间包括区间开始时间点,但不包括区间结束时间点。如果 from 和 to 的值相同,则为无效区间,函数直接返回错误。

1409529600
Tointeger

子时间区间的结束时间点。UNIX 时间戳格式,表示从 1970-1-1 00:00:00 UTC 计算起的秒数。时间区间遵循“左闭右开”原则,即该时间区间包括区间开始时间点,但不包括区间结束时间点。如果 from 和 to 的值相同,则为无效区间,函数直接返回错误。

1409569200
RegionIdstring

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

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

返回参数

名称类型描述示例值
object

CloudSiemResponse

Dataobject

直方图数据。

Serverstring

服务器名称。

nginx
TotalCountlong

该子时间区间内查询到的日志条数。

2
Histogramsobject []

具体日志分布情况。

Frominteger

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

1409529600
Tointeger

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

1409569200
Countlong

子时间区间的日志数量。

100
CompletedOrNotboolean

当前查询结果在该子时间区间内的结果是否完整。取值:

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

请求消息 ID。

97A31C3A-3F9F-5866-8979-5159E3DC****

示例

正常返回示例

JSON格式

{
  "Data": {
    "Server": "nginx",
    "TotalCount": 2,
    "Histograms": [
      {
        "From": 1409529600,
        "To": 1409569200,
        "Count": 100,
        "CompletedOrNot": true
      }
    ]
  },
  "RequestId": "97A31C3A-3F9F-5866-8979-5159E3DC****"
}

错误码

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)