获取事件

GET/zstack/v1/zwatch/events

Headers

Authorization: OAuth the-session-uuid

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/zwatch/events?startTime=1.596444516295E12&limit=10.0&conditions=HostUuid=99ca12b945a8489c93a3412cbc744193&count=false&start=0.0

参数列表

名字类型位置描述可选值起始版本
startTime (可选)Longquery起始时间 2.3
endTime (可选)Longquery结束时间 2.3
limit (可选)Integerquery最大返回条数 2.3
offsetAheadOfCurrentTime (可选)Longquery早于当前时间的毫秒数,例如:查询最近一小时的消息,则传入3600000 3.3.0
conditions (可选)Listquery查询条件 3.3.0
count (可选)booleanquery是否查询事件数量 3.3.0
endpointUuid (可选)Stringquery接收端Uuid 3.10.0
systemTags (可选)Listquery系统标签 2.3
userTags (可选)Listquery用户标签 2.3

API返回

返回示例

{
  "events": [
    {
      "namespace": "ZStack/VM",
      "name": "org.zstack.zwatch.datatype.EventFamily@2c24d960",
      "labels": {},
      "emergencyLevel": "Normal",
      "resourceId": "b7bbe5fb9ab049c5a36bf8a646471cff",
      "resourceName": "VmInstanceVO",
      "time": 1596444516324.0
    }
  ]
}
名字类型描述起始版本
totalLong事件数目3.3.0
successboolean 3.3.0
errorErrorCode错误码,若不为null,则表示操作失败, 操作成功时该字段为null。 详情参考error2.3
eventsList详情参考events2.3

error

名字类型描述起始版本
codeString错误码号,错误的全局唯一标识,例如SYS.1000, HOST.10012.3
descriptionString错误的概要描述2.3
detailsString错误的详细信息2.3
elaborationString保留字段,默认为null2.3
opaqueLinkedHashMap保留字段,默认为null2.3
causeErrorCode根错误,引发当前错误的源错误,若无原错误,该字段为null2.3

events

名字类型描述起始版本
namespaceString名字空间2.3
nameString事件名2.3
labelsMap标签2.3
resourceIdString产生事件资源的ID(如果为ZSvirt资源则为资源UUID)2.3
resourceNameString资源名称2.3
errorString如果事件代表错误,该字段为错误详情2.3
timelong事件产生时间2.3
dataUuidString消息UUID3.3
accountUuidString账户UUID3.3
emergencyLevelEmergencyLevel详情参考emergencyLevel2.3

emergencyLevel

名字类型描述起始版本
nameString资源名称2.3
ordinalint 2.3

SDK示例

Java SDK

GetEventDataAction action = new GetEventDataAction();
action.startTime = 1.596444516404E12;
action.limit = 10.0;
action.conditions = asList("HostUuid=00d80d7c47124d6d8e2c7736e9af1c34");
action.count = false;
action.start = 0.0;
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
GetEventDataAction.Result res = action.call();

Python SDK

GetEventDataAction action = GetEventDataAction()
action.startTime = 1.596444516405E12
action.limit = 10.0
action.conditions = [HostUuid=7581302347d0439fbdde32b914e2449a]
action.count = false
action.start = 0.0
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
GetEventDataAction.Result res = action.call()