LookupEvents - 检索详细事件

更新时间:2024-11-26 03:08:53

检索详细历史事件。

接口说明

使用限制:调用 LookupEvents 接口检索事件时,每秒钟最多调用两次。

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

调试

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

授权信息

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

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

请求参数

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

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

说明
请求参数必须保证和上次请求一致。
eyJhY2NvdW50IjoiMTQyNDM3OTU4NjM4NzE2MSIsImV2ZW50SWQiOiI3MkJDRTExRi02OTU3LTQ0NUItQjY0MC1CNEUyMkM4NUEwQzgiLCJsb2dJZCI6IjgyLTE0MjQzNzk1ODYzODcxNjEiLCJ0aW1lIjoxNjAyMzExNTQwMD****
MaxResultsstring

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

20
StartTimestring

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

2020-10-08T11:00:00Z
EndTimestring

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

2020-10-15T11:00:00Z
Directionstring

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

  • FORWARD:正序。
  • BACKWARD(默认值):反序。
BACKWARD
LookupAttributearray<object>

检索条件。

object
Keystring

检索条件的 Key。取值:

  • ServiceName:云服务名称。
  • EventName:事件名称。
  • User:调用者名称,即 RAM 用户。
  • EventId:事件 ID。
  • ResourceType:资源类型。
  • ResourceName:资源名称。
  • EventRW:请求事件的读写类型。
  • EventAccessKeyId:事件的 AccessKey ID。
  • SensitiveAction:敏感事件。
说明
一次只能指定一个检索条件。
ServiceName
Valuestring

检索条件的 Value。取值:

  • 当 LookupAttribute.N.Key 取值为 ServiceName 时,取值示例:Ecs
  • 当 LookupAttribute.N.Key 取值为 EventName 时,取值示例:ConsoleSignin
  • 当 LookupAttribute.N.Key 取值为 User 时,取值示例:Alice
  • 当 LookupAttribute.N.Key 取值为 EventId 时,取值示例:B702AFA3-FD4B-40E3-88E4-C0752FAA****
  • 当 LookupAttribute.N.Key 取值为 ResourceType 时,取值示例:ACS::ECS::Instance
  • 当 LookupAttribute.N.Key 取值为 ResourceName 时,取值示例:i-bp14664y88udkt45****
  • 当 LookupAttribute.N.Key 取值为 EventRW 时,取值:Read(读类型)、Write(写类型)。
  • 当 LookupAttribute.N.Key 取值为 EventAccessKeyId 时,取值示例:LTAI4FoDkCf4DU1bic1V****
  • 当 LookupAttribute.N.Key 取值为 SensitiveAction 时,取值示例:true(是)。
Ecs

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

返回参数

名称类型描述示例值
名称类型描述示例值
object
EndTimestring

检索到事件的结束时间。

2020-07-22T14:00:00Z
Eventsarray<object>

检索到的事件列表。

Eventsobject

检索到的事件列表。

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

见返回示例
NextTokenstring

返回下一页的检索结果。

说明
若无更多结果,则不返回此字段。
eyJhY2NvdW50IjoiMTQyNDM3OTU4NjM4NzE2MSIsImV2ZW50SWQiOiI3MkJDRTExRi02OTU3LTQ0NUItQjY0MC1CNEUyMkM4NUEwQzgiLCJsb2dJZCI6IjgyLTE0MjQzNzk1ODYzODcxNjEiLCJ0aW1lIjoxNjAyMzExNTQwMD****
RequestIdstring

请求 ID。

FD79665A-CE8B-49D4-82E6-5EE2E0E791DD
StartTimestring

检索到事件的开始时间。

2020-07-15T14:00:00Z

示例

正常返回示例

JSON格式

{
  "EndTime": "2020-07-22T14:00:00Z",
  "Events": [
    {
      "test": "test",
      "test2": 1
    }
  ],
  "NextToken": "eyJhY2NvdW50IjoiMTQyNDM3OTU4NjM4NzE2MSIsImV2ZW50SWQiOiI3MkJDRTExRi02OTU3LTQ0NUItQjY0MC1CNEUyMkM4NUEwQzgiLCJsb2dJZCI6IjgyLTE0MjQzNzk1ODYzODcxNjEiLCJ0aW1lIjoxNjAyMzExNTQwMD****",
  "RequestId": "FD79665A-CE8B-49D4-82E6-5EE2E0E791DD",
  "StartTime": "2020-07-15T14:00:00Z"
}

错误码

HTTP status code错误码错误信息描述
HTTP status code错误码错误信息描述
400IncompleteSignatureThe request signature does not conform to Alibaba Cloud standards.签名不匹配。请检查AcceseKey IDAccessKey Secret是否正确;检查签名方法是否正确。详细信息参见“签名机制”。
400InvalidParameterCombinationThe end time must be later than the start time.结束时间必须晚于开始时间。
400InvalidQueryParameterThe specified query parameter is invalid.无效的查询参数。
400InvalidParameterEndTimeThe specified EndTime is invalid.无效的参数EndTime。
400InvalidParameterStartTimeThe specified StartTime is invalid.无效的参数StartTime。

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

变更历史

变更时间变更内容概要操作
变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
  • 接口说明
  • 调试
  • 授权信息
  • 请求参数
  • 返回参数
  • 示例
  • 错误码
  • 变更历史
AI助理

点击开启售前

在线咨询服务

你好,我是AI助理

可以解答问题、推荐解决方案等