调用ListInstanceHistoryEvents,查看Elasticsearch集群触发的硬件运维事件列表。

调试

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

请求头

该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。

请求语法

POST /openapi/events HTTP/1.1

请求参数

名称 类型 位置 是否必选 示例值 描述
instanceId String Query es-cn-2r42l7a740005****

实例ID。

nodeIP String Query 10.1.xx.xx

触发事件的节点的IP地址。

eventType Array of String Query Instance:InstanceFailure.Reboot:Executed

事件类型,可选值如下,多个类型使用英文逗号(,)隔开:

  • ECS:AUTO_RESTART:ECS节点自动重启。
  • Instance:InstanceFailure.Reboot:Executed:ECS实例重启结束(ECS实例错误)。
  • Instance:InstanceFailure.Reboot:Executing:ECS实例重启开始(实例错误)。
  • Instance:SystemFailure.Reboot:Executed:ECS实例重启结束(系统错误)。
  • Instance:SystemFailure.Reboot:Executing:ECS实例重启开始(系统错误)。
  • Instance:SystemFailure.Reboot:Failed:ECS实例重启失败(系统错误)。
eventLevel Array of String Query INFO,WARN

事件等级,可选值如下,多个等级用英文逗号(,)隔开:

  • INFO:信息
  • WARN:警告
  • CRITICAL:紧急
eventCreateStartTime String Query 1645596516000

按照事件创建时间查询,起始时间。采用时间戳形式,单位为毫秒。

eventCreateEndTime String Query 1645596516000

按照事件创建时间查询,结束时间。采用时间戳形式,单位为毫秒。

eventExecuteStartTime String Query 1645596516000

按照事件执行时间查询,起始时间。采用时间戳形式,单位为毫秒。

eventExecuteEndTime String Query 1645596516000

按照事件执行时间查询,结束时间。采用时间戳形式,单位为毫秒。

eventFinashStartTime String Query 1645596516000

按照事件完成时间查询,起始时间。采用时间戳形式,单位为毫秒。

eventFinashEndTime String Query 1645596516000

按照事件完成时间查询,结束时间。采用时间戳形式,单位为毫秒。

page Integer Query 0

起始文档偏移量。需要为非负数,默认为0。

size Integer Query 10

要返回的事件数量。需要为非负数,默认为10。

eventCycleStatus Array of String Query EXECUTED,FAILED

事件的生命周期状态,可选值如下,多个状态使用英文逗号(,)隔开:

  • FAILED:失败
  • EXECUTED:已执行
  • EXECUTING:执行中
Array Body

请求体参数。

sortField String Body event_time

返回结果按照哪个字段排序,可选值如下:

  • event_time:事件创建时间
  • event_execute_start_time:事件执行时间
  • event_execute_finish_time:事件完成时间
desc Boolean Body true

是否倒序:

  • true(默认):是
  • false:否

返回数据

名称 类型 示例值 描述
RequestId String D1A6830A-F59B-4E05-BFAC-9496C21DBBA7

请求ID。

Headers Object

返回头信息。

X-Total-Count Long 15

总记录数。

X-Total-Failed Long 2

总失败数。

X-Total-Success Long 13

总成功数。

Result Array of Result

返回结果。

eventCreateTime String 2017-12-07T00:00:00Z

事件创建时间。

eventCycleStatus String EXECUTED

事件状态,支持:

  • FAILED:失败
  • EXECUTED:已执行
  • EXECUTING:执行中
eventExecuteTime String 2017-12-07T00:00:00Z

事件执行时间。

eventFinashTime String 2017-12-07T00:00:00Z

事件完成时间。

eventLevel String INFO

事件等级,支持:

  • INFO:信息
  • WARN:警告
  • CRITICAL:紧急
instanceId String es-cn-2r42l7a740005****

实例ID。

nodeIP String 10.1.xx.xx

产生事件的节点的IP地址。

eventType String ECS:AUTO_RESTART

事件类型,支持:

  • ECS:AUTO_RESTART:ECS节点自动重启。
  • Instance:InstanceFailure.Reboot:Executed:ECS实例重启结束(ECS实例错误)。
  • Instance:InstanceFailure.Reboot:Executing:ECS实例重启开始(实例错误)。
  • Instance:SystemFailure.Reboot:Executed:ECS实例重启结束(系统错误)。
  • Instance:SystemFailure.Reboot:Executing:ECS实例重启开始(系统错误)。
  • Instance:SystemFailure.Reboot:Failed:ECS实例重启失败(系统错误)。
regionId String cn-hangzhou

事件所在的地域ID。

ecsId String i-2ze8s9cjdf2cv969****

ECS实例ID。

示例

请求示例

POST /openapi/events?instanceId=es-cn-2r42l7a740005****&nodeIP=10.1.xx.xx&eventType=["ECS:AUTO_RESTART, Instance:InstanceFailure"]&eventLevel=["INFO,WARN"]&eventCreateStartTime=1645596516000&eventCreateEndTime=1645596516000&eventExecuteStartTime=1645596516000&eventExecuteEndTime=1645596516000&eventFinashStartTime=1645596516000&eventFinashEndTime=1645596516000&page=0&size=10&eventCycleStatus=["EXECUTED,FAILED"] HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json

[ {
  "sortField" : "event_time",
  "desc" : true
} ]

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ListInstanceHistoryEventsResponse>
    <RequestId>D1A6830A-F59B-4E05-BFAC-9496C21DBBA7</RequestId>
    <Headers>
        <X-Total-Count>15</X-Total-Count>
        <X-Total-Failed>2</X-Total-Failed>
        <X-Total-Success>13</X-Total-Success>
    </Headers>
    <Result>
        <eventCreateTime>2017-12-07T00:00:00Z</eventCreateTime>
        <eventCycleStatus>EXECUTED</eventCycleStatus>
        <eventExecuteTime>2017-12-07T00:00:00Z</eventExecuteTime>
        <eventFinashTime>2017-12-07T00:00:00Z</eventFinashTime>
        <eventLevel>INFO</eventLevel>
        <instanceId>es-cn-2r42l7a740005****</instanceId>
        <nodeIP>10.1.xx.xx</nodeIP>
        <eventType>ECS:AUTO_RESTART</eventType>
        <regionId>cn-hangzhou</regionId>
        <ecsId>i-2ze8s9cjdf2cv969****</ecsId>
    </Result>
</ListInstanceHistoryEventsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "D1A6830A-F59B-4E05-BFAC-9496C21DBBA7",
  "Headers" : {
    "X-Total-Count" : 15,
    "X-Total-Failed" : 2,
    "X-Total-Success" : 13
  },
  "Result" : [ {
    "eventCreateTime" : "2017-12-07T00:00:00Z",
    "eventCycleStatus" : "EXECUTED",
    "eventExecuteTime" : "2017-12-07T00:00:00Z",
    "eventFinashTime" : "2017-12-07T00:00:00Z",
    "eventLevel" : "INFO",
    "instanceId" : "es-cn-2r42l7a740005****",
    "nodeIP" : "10.1.xx.xx",
    "eventType" : "ECS:AUTO_RESTART",
    "regionId" : "cn-hangzhou",
    "ecsId" : "i-2ze8s9cjdf2cv969****"
  } ]
}

错误码

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