查询指定时间段发生的事件详情。
为保证接口服务的稳定,云监控对 ListEvents 接口进行了流量控制。建议您每秒请求数(QPS)值不大于 20,否则将触发限流。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListEvents | 接口名称。当前 API 的名称为 ListEvents 。 |
Version | String | 是 | 2018-01-01 | 接口版本。当前 API 的版本为 2018-01-01 。 |
ID | Array of String | 否 | ["155630285718605****", "155629834700901****"] | 事件 ID。默认值为空,表示查询指定时间段内发生的所有事件的详细信息。 |
StartTime | Integer | 否 | 1659885000 | 查询时间段的开始时间,秒级时间戳。该时间范围只对事件的发生时间(HappenTime)生效。 |
EndTime | Integer | 否 | 1659890000 | 查询时间段的结束时间,秒级时间戳。该时间范围只对事件的发生时间(HappenTime)生效。 |
Source | Array of String | 否 | ["ecs"] | 事件源。 |
EventType | Array of String | 否 | ["ecs:Instance:StateChange"] | 事件。每一个事件由 |
Region | String | 否 | cn-shanghai | 发生的事件所属的可用区 ID。 |
PageSize | Integer | 否 | 30 | 分页查询参数,用于设置每页行数。默认值:30。 |
PageNumber | Integer | 否 | 1 | 分页查询参数,用于设置当前页码。默认值:1。 |
OrderBy | String | 否 | HappenTime | 事件排列依据。目前仅支持设置为HappenTime ,表示根据事件发生时间排列。 |
Asc | Boolean | 否 | false | 事件排序方式。取值:
|
POST https://open.volcengineapi.com?Action=ListEvents&Version=2018-01-01 Content-Type: application/json { "Asc": true, "StartTime": 1659885000, "EndTime": 1659890000, "EventType": [ "ecs:Instance:StateChange" ], "ID": [ "155630285718605****", "155629834700901****" ], "OrderBy": "HappenTime", "PageNumber": 1, "PageSize": 30, "Region": "cn-shanghai", "Source": [ "ecs" ] }
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Asc | Boolean | false | 返回事件的排序方式。 |
Data | Array of EventOpenAPIVo | - | 符合查询条件的事件详情。 |
OrderBy | String | HappenTime | 返回事件的排序依据。 |
PageSize | Integer | 30 | 分页查询参数,用于设置每页行数。默认值为 30。 |
PageNumber | Integer | 1 | 分页查询参数,用于设置当前页码。默认值为 1。 |
TotalCount | Integer | 10 | 符合条件的事件数量。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
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 格式。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
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 | 接收事件的资源名称。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
key | String | resourceid | data 定义的 key。 |
value | Any | 100**** | data 定义的 value。 |
{ "ResponseMetadata": { "Action": "ListEvents", "Region": "cn-beijing", "Service": "volc_observe", "Version": "2018-01-01", "RequestId": "20230604110420****100232280022D31" }, "Result": { "Data": [ { "ID": "155630285718605****", "Detail": { "id": "1658*****4000", "type": "ecs:Disk:DiskError.Redeploy.Executing", "ctime": "2023-05-16T14:23:26+08:00", "source": "ecs", "subject": "ecs:cn-north-1:21*****53:instance/test-instanceId-A/tag/test-instanceId-B", "volcregion": "cn-guangzhou", "specversion": "1.0", "volcaccountid": "21*****53", "datacontenttype": "application/json", "volcpublishtime": "2023-05-16T14:23:26+08:00", "publishTimeStamp": 1684218206, "volceventbusname": "default", "volcresourcename": "test_resource_name_A" }, "Region": "cn-shanghai", "Source": "ecs", "EventType": "ecs:Instance:SystemFailure.Redeploy.Executing", "HappenTime": 1659886490 } ], "PageSize": 30, "PageNumber": 1, "TotalCount": 2 } }
本接口无特有的错误码。更多信息请参见 错误码。