文档中心

ListEvents

最近更新时间：2024.05.16 17:08:33

首次发布时间：2022.08.19 17:32:39

调用ListEvents查询指定时间段发生的事件详情。

使用限制

为保证接口服务的稳定，云监控对ListEvents接口进行了流量控制。建议您每秒请求数（QPS）值不大于20，否则将触发限流。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=ListEvents&Version=2018-01-01

ServiceName : Volc_Observe 
Region : cn-beijing 
AccessKey : xxx 
SecretKey : xxx

调试

API Explorer

您可以通过API Explorer在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ListEvents`	接口名称。当前 API 的名称为 `ListEvents`。
Version	String	是	`2018-01-01`	接口版本。当前 API 的版本为 `2018-01-01`。

Body

参数	类型	是否必选	示例值	描述
ID	Array of String	否	`["155630285718605**", "155629834700901**"]`	事件ID。默认值为空，表示查询指定时间段内发生的所有事件的详细信息。
StartTime	Integer	否	`1659885000`	查询时间段的开始时间，秒级时间戳。该时间范围只对事件的发生时间（HappenTime）生效。如果未设置StartTime和EndTime参数，则默认查询最近30分钟内发生的事件详情。
EndTime	Integer	否	`1659890000`	查询时间段的结束时间，秒级时间戳。该时间范围只对事件的发生时间（HappenTime）生效。如果未设置StartTime和EndTime参数，则默认查询最近30分钟内发生的事件详情。
Source	Array of String	否	`["ecs"]`	事件源。例如，`ecs`表示云服务器、`rds_mysql`表示云数据库MySQL版、`redis`表示缓存数据库Redis版。参数值格式示例：`["testA", "testB", "testC"]`。默认值为空，表示查询所有事件源的详细信息。
EventType	Array of String	否	`["ecs:Instance:StateChange"]`	事件。每一个事件由`事件源:事件类型:事件内容`组成。参数值格式示例：`["testA", "testB", "testC"]`。各云产品事件列表，请参见云产品事件概述。
Region	String	否	`cn-shanghai`	发生的事件所属的可用区ID。
PageSize	Integer	否	`30`	分页查询参数，用于设置每页行数。默认值：30。
PageNumber	Integer	否	`1`	分页查询参数，用于设置当前页码。默认值：1。
OrderBy	String	否	`HappenTime`	事件排列依据。目前仅支持设置为HappenTime，表示根据事件发生时间排列。
Asc	Boolean	否	`false`	事件排序方式。取值： true：升序。 false：降序。

返回参数

参数	类型	示例值	描述
Asc	Boolean	`false`	返回事件的排序方式。
Data	Array of EventOpenAPIVo	`-`	符合查询条件的事件详情。
OrderBy	String	`HappenTime`	返回事件的排序依据。
PageSize	Integer	`10`	当前分页的行数。
PageNumber	Integer	`1`	当前页码。
TotalCount	Integer	`10`	符合条件的对象分组总数。

EventOpenAPIVo

参数	类型	示例值	描述
ID	String	`155630285718605****`	事件ID。
HappenTime	Integer	`1659886490`	事件发生时间，秒级时间戳。
Source	String	`ecs`	事件源。
EventType	String	`ecs:Instance:SystemFailure.Redeploy.Executing`	事件。
Region	String	`cn-shanghai`	事件发生的可用区ID。
Detail	Object of EventAlias	`-`	事件原文，内容为JSON格式。

EventAlias

参数	类型	示例值	描述
id	String	`1658*****4000`	事件ID。标识事件的唯一值。
data	JSON Map	`-`	事件内容。JSON对象，内容由发起事件的服务决定。
type	String	`ecs:Disk:DiskError.Redeploy.Executing`	事件类型。描述事件源相关的事件类型。
ctime	String	`2023-05-16T14:23:26+08:00`	事件产生的时间。
source	String	`ecs`	事件源。提供事件的服务。
subject	String	`ecs:cn-north-1:21*****53:instance/test-instanceId-A/tag/test-instanceId-B`	事件主体。
volcregion	String	`cn-guangzhou`	接收事件的地域。
specversion	String	`1.0`	CloudEvents协议版本。
volcaccountid	String	`21*****53`	火山引擎账号ID。
datacontenttype	String	`application/json`	参数data的内容形式。只支持application/json格式。
volcpublishtime	String	`2023-05-16T14:23:26+08:00`	接收事件的时间。
publishTimeStamp	Integer	`1684218206`	接收事件的时间戳。
volceventbusname	String	`default`	接收事件的事件总线名称。
volcresourcename	String	`test_resource_name_A`	接收事件的资源名称。

Data

参数	类型	示例值	描述
key	String	`resourceid`	data定义的key。
value	Any	`100****`	data定义的key对应的value。

请求示例

POST https://open.volcengineapi.com?Action=ListEvents&Version=2018-01-01
ServiceName: Volc_Observe
Region: cn-beijing
AccessKey: xxx
SecretKey: xxx
{
    "StartTime": 1659885000,
    "EndTime": 1659890000
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230*****44C52",
        "Action": "ListEvents",
        "Version": "2018-01-01",
        "Service": "Volc_Observe",
        "Region": "cn-beijing"
    },
    "Result": {
        "Data":[
            {
                "ID":"155630285718605****",
                "Source":"ecs",
                "EventType":"ecs:Instance:SystemFailure.Redeploy.Executing",
                "Region":"cn-shanghai",
                "HappenTime":1659886490,
                "Detail":{
                    "specversion":"1.0",
                    "id":"155630285718605****",
                    "source":"ecs",
                    "type":"ecs:Instance:SystemFailure.Redeploy.Executing",
                    "volcpublishtime":"2022-08-07T23:34:50+08:00",
                    "volcregion":"cn-shanghai",
                    "volcaccountid":"21****",
                    "volceventbusname":"default",
                    "time":"2022-08-07T23:34:50+08:00",
                    "data":{
                        "resourceid":"100****"
                    },
                    "admin":"event_center_test",
                    "handlers":[
                        "ByteBot",
                        "值班人",
                        "BOE"
                    ],
                    "env":"dev"
                }
            },
            {
                "ID":"155629834700901****",
                "Source":"ecs",
                "EventType":"ecs:Instance:SystemFailure.Redeploy.Executing",
                "Region":"cn-beijing",
                "EventBusName":"default",
                "HappenTime":1659885415,
                "Detail":{
                    "specversion":"1.0",
                    "id":"155629834700901****",
                    "source":"ecs",
                    "type":"ecs:Instance:SystemFailure.Redeploy.Executing",
                    "volcpublishtime":"2022-08-07T23:16:55+08:00",
                    "volcregion":"cn-beijing",
                    "volcaccountid":"21****",
                    "volceventbusname":"default",
                    "time":"2022-08-07T23:16:55+08:00",
                    "data":{
                        "resourceid":"100****"
                    },
                    "admin":"event_center_test",
                    "handlers":[
                        "ByteBot",
                        "值班人",
                        "BOE"
                    ],
                    "env":"dev"
                }
            }
        ],
        "PageNumber":1,
        "PageSize":30,
        "TotalCount":2,
        "OrderBy":"HappenTime",
        "Asc":false
    }
}