You need to enable JavaScript to run this app.
导航

ListEvents

最近更新时间2023.03.31 16:12:21

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

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

接口说明

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

Request URL

POST https://open.volcengineapi.com?Action=ListEvents&Version=2018-01-01
ServiceName : Volc_Observe
Region : cn-beijing 
AccessKey : xxx
SecretKey : xxx

请求参数

名称

类型

是否必填

示例值

描述

ID

Array

["155630285718605****", "155629834700901****"]

事件ID。默认值为空,表示查询指定时间段内发生的所有事件的详细信息。

StartTime

Integer

1659885000

查询时间段的开始时间,秒级时间戳。该时间范围只对事件的发生时间(HappenTime)生效。
如果未设置StartTime和EndTime参数,则默认查询最近30分钟内发生的事件详情。

EndTime

Integer

1659890000

查询时间段的结束时间,秒级时间戳。该时间范围只对事件的发生时间(HappenTime)生效。
如果未设置StartTime和EndTime参数,则默认查询最近30分钟内发生的事件详情。

Source

Array

["ecs"]

事件源。
例如,ecs表示云服务器、rds_mysql表示云数据库MySQL版、redis表示缓存数据库Redis版。
参数值格式示例:["testA", "testB", "testC"]
默认值为空,表示查询所有事件源的详细信息。

EventType

Array

["ecs:Instance:StateChange"]

事件。每一个事件由事件源:事件类型:事件内容组成。参数值格式示例:["testA", "testB", "testC"]
各云产品事件列表,请参见云产品事件概述

Region

String

cn-shanghai

发生的事件所属的可用区ID。

EventBusName

String

default

事件总线名称。目前仅支持设置为default

PageSize

Integer

30

分页查询参数,用于设置每页行数。默认值:30。

PageNumber

Integer

1

分页查询参数,用于设置当前页码。默认值:1。

OrderBy

String

HappenTime

事件排列依据。目前仅支持设置为HappenTime,表示根据事件发生时间排列。

Asc

Bool

false

事件排序方式。取值:

  • true:升序。
  • false:降序。

返回参数

名称

类型

示例值

描述

Data

Array

-

符合查询条件的事件详情。具体参数请参见Data数据结构

PageSize

Integer

30

当前分页的行数。

PageNumber

Integer

1

当前页码。

OrderBy

String

HappenTime

返回事件的排序依据。

Asc

Bool

false

返回事件的排序方式。

TotalCount

Integer

10

符合查询条件的事件总数。

Data数据结构

名称

类型

示例值

描述

ID

String

155630285718605****

事件ID。

HappenTime

Timestamp

1659886490

事件发生时间,秒级时间戳。

Source

String

ecs

事件源。

EventType

String

ecs:Instance:SystemFailure.Redeploy.Executing

事件。

Region

String

cn-shanghai

事件发生的可用区ID。

EventBusName

String

default

当前事件所属的事件总线名称。

Detail

Map

-

事件原文,内容为JSON格式。

请求示例

POST https://open.volcengineapi.com?Action=ListEvents&Version=2018-01-01
ServiceName=Volc_Observe
Region=cn-beijing 
AccessKey=xxx 
SecretKey=xxx 

{
    "EventBusName": "default",
    "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",
                "EventBusName":"default",
                "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
    }
}