LookupEvents - 检索详细事件

检索详细历史事件。

接口说明

说明

请勿频繁调用该接口。您可以创建跟踪,将事件投递到日志服务 SLS,通过 SLS 的实时消费功能来近实时地检索事件。具体操作,请参见创建单账号跟踪创建多账号跟踪实时消费

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

actiontrail:LookupEvents

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

NextToken

string

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

说明

请求参数必须保证和上次请求一致。

eyJhY2NvdW50IjoiMTQyNDM3OTU4NjM4NzE2MSIsImV2ZW50SWQiOiI3MkJDRTExRi02OTU3LTQ0NUItQjY0MC1CNEUyMkM4NUEwQzgiLCJsb2dJZCI6IjgyLTE0MjQzNzk1ODYzODcxNjEiLCJ0aW1lIjoxNjAyMzExNTQwMD****

MaxResults

string

允许返回的最大结果数目。
取值范围:1~50。

20

StartTime

string

检索事件的开始时间,日期格式按照 ISO8601 标准,并使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ

说明

StartTime 和 EndTime 需同时设置或均不设置,不设置时 StartTime 默认为当前时间 7 天前的时间点。

2020-10-08T11:00:00Z

EndTime

string

检索事件的结束时间,日期格式按照 ISO8601 标准,并使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ

说明

StartTime 和 EndTime 需同时设置或均不设置,不设置时 EndTime 默认为当前时间点。

2020-10-15T11:00:00Z

Direction

string

检索事件的读取顺序,取值:

  • FORWARD:正序。

  • BACKWARD(默认值):反序。

BACKWARD

LookupAttribute

array<object>

检索条件。

说明

一次只能指定一个或两个检索条件,参考限制说明

object

Key

string

检索条件的 Key。取值请参见: 调用 LookupEvents 接口检索事件时如何设置 LookupAttribute 参数

ServiceName

Value

string

检索条件的 Value。取值请参见: 调用 LookupEvents 接口检索事件时如何设置 LookupAttribute 参数

Ecs

关于公共请求参数的详情,请参见公共参数

返回参数

名称

类型

描述

示例值

object

EndTime

string

检索到事件的结束时间。

2020-07-22T14:00:00Z

Events

array<object>

检索到的事件列表。

object

检索到的事件列表。

关于事件列表中事件字段的说明,请参见操作事件结构定义

{ "eventId": "6EEC3A76-C207-5075-889D-A909E62F****", "eventVersion": 1, "eventName": "GetTemplate" }

NextToken

string

返回下一页的检索结果。

说明

若无更多结果,则不返回此字段。

eyJhY2NvdW50IjoiMTQyNDM3OTU4NjM4NzE2MSIsImV2ZW50SWQiOiI3MkJDRTExRi02OTU3LTQ0NUItQjY0MC1CNEUyMkM4NUEwQzgiLCJsb2dJZCI6IjgyLTE0MjQzNzk1ODYzODcxNjEiLCJ0aW1lIjoxNjAyMzExNTQwMD****

RequestId

string

请求 ID。

FD79665A-CE8B-49D4-82E6-5EE2E0E7****

StartTime

string

检索到事件的开始时间。

2020-07-15T14:00:00Z

示例

正常返回示例

JSON格式

{
  "EndTime": "2020-07-22T14:00:00Z",
  "Events": [
    {
      "eventId": "6EEC3A76-C207-5075-889D-A909E62F****",
      "eventVersion": 1,
      "eventName": "GetTemplate"
    }
  ],
  "NextToken": "eyJhY2NvdW50IjoiMTQyNDM3OTU4NjM4NzE2MSIsImV2ZW50SWQiOiI3MkJDRTExRi02OTU3LTQ0NUItQjY0MC1CNEUyMkM4NUEwQzgiLCJsb2dJZCI6IjgyLTE0MjQzNzk1ODYzODcxNjEiLCJ0aW1lIjoxNjAyMzExNTQwMD****",
  "RequestId": "FD79665A-CE8B-49D4-82E6-5EE2E0E7****",
  "StartTime": "2020-07-15T14:00:00Z"
}

错误码

HTTP status code

错误码

错误信息

描述

400 IncompleteSignature The request signature does not conform to Alibaba Cloud standards. 签名不匹配。请检查AcceseKey IDAccessKey Secret是否正确;检查签名方法是否正确。详细信息参见“签名机制”。
400 InvalidParameterCombination The end time must be later than the start time. 结束时间必须晚于开始时间。
400 InvalidQueryParameter The specified query parameter is invalid. 无效的查询参数。
400 InvalidParameterEndTime The specified EndTime is invalid. 无效的参数EndTime。
400 InvalidParameterStartTime The specified StartTime is invalid. 无效的参数StartTime。

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

变更历史

更多信息,参考变更详情