EventCenterQueryEvents - 在事件分析功能中查询事件

EventCenterQueryEvents

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

eventbridge:EventCenterQueryEvents

get

*EventBus

acs:eventbridge:{#regionId}:{#accountId}:eventbus/{#eventbus}

请求参数

名称

类型

必填

描述

示例值

BusName

string

总线名称

default

NextToken

string

用于请求下一页检索的结果。

100

MaxResults

integer

允许返回的最大结果数目。 取值范围:0~10000,默认 100。

100

Body

object

Body 参数

SchemaId

string

Schema ID。

ecs:GeneralSchema

QueryType

string

查询类型:

  • timeseries:查询时序数据

  • table:查询表格数据

  • timeseries_and_table:同时查询时序数据和表格数据

timeseries_and_table

Parameters

object

查询参数。

Breakdowns

array

将数据集按照特定维度(列名)进一步拆分。

string

可作为拆分维度的列名。

source

Calculations

array

对指定的列用操作符计算。

object

Op

string

操作符。

COUNT_DISTINCT

Column

string

列名。

source

Filters

array

筛选条件列表。

array<object>

Column

string

列名。

source

Op

string

操作符。

=

Values

array

与操作符配合使用的值。

string

如值为字符串,则需要用加上单引号。

'acs.ecs'

NestedFilterCombination

string

AND

NestedFilters

array

object

Column

string

Op

string

Values

array

string

FilterCombination

string

筛选条件组合的逻辑。

AND

Granularity

integer

时间粒度,即查询时序数据的最小时间单元,单位秒,最小值为 1。 此参数为建议值,实际粒度以返回值为准。

30

Orders

array

对查询结果排序,仅对 QueryType 为 table 的查询有意义。

object

Op

string

操作符。

AVG

Column

string

列名。

source

Desc

boolean

是否降序排列

true

Offset

integer

本次查询的起始位置,从 0 开始。

0

Limit

integer

查询事件的最大个数,取值范围为 1~10000。

100

TimeRange

integer

时间范围,单位毫秒,最小值 1000。

1000000

StartTime

integer

查询事件的开始时间戳,单位毫秒。

1687860901814

EndTime

integer

查询事件的结束时间戳,单位毫秒。

1687861201814

返回参数

名称

类型

描述

示例值

object

Schema of Response

Message

string

错误信息。

Specified parameter Limit is not valid.

RequestId

string

本次请求的 ID。

5DAF96FB-A4B6-548C-B999-XXXXXXXX

Data

object

返回结果。

NextToken

string

表示当前调用返回读取到的位置。空代表数据已经读取完毕。

100

MaxResults

integer

本次请求所返回的最大记录条数

100

TotalCount

integer

TotalCount 本次请求条件下的数据总量,此参数为可选参数,默认可不返回

76

TimeSeries

array<object>

对应查询类型为 timeseries 的查询结果。

object

RowData

object

查询结果的条目,以 k-v 对表示。

{ "id":"xxx", "source":"acs.ecs" }

Time

string

用于显示时间戳。

1683561600000

Table

array<object>

对应查询类型为 table 的查询结果。

object

RowData

object

查询结果的条目,以 k-v 对表示。

{ "id":"xxx", "source":"acs.ecs" }

Code

string

接口状态或 POP 错误码。取值说明如下:Success:成功。

Success

Success

boolean

操作是否成功。true 表示成功,false 表示失败。

true

示例

正常返回示例

JSON格式

{
  "Message": "Specified parameter Limit is not valid.",
  "RequestId": "5DAF96FB-A4B6-548C-B999-XXXXXXXX",
  "Data": {
    "NextToken": "100",
    "MaxResults": 100,
    "TotalCount": 76,
    "TimeSeries": [
      {
        "RowData": {
          "id": "xxx",
          "source": "acs.ecs"
        },
        "Time": "1683561600000"
      }
    ],
    "Table": [
      {
        "RowData": {
          "id": "xxx",
          "source": "acs.ecs"
        }
      }
    ]
  },
  "Code": "Success",
  "Success": true
}

错误码

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

变更历史

更多信息,参考变更详情