更新事件消息

PUT/zstack/v1/zwatch/events/actions

Request

cURL

curl --request PUT \
  --url '/v1/zwatch/events/actions' \
  --header 'Content-Type: application/json' \
  --data '{}'

{
  "status": "ok",
  "method": "PUT",
  "path": "/v1/zwatch/events/actions"
}

Headers

Authorization: OAuth the-session-uuid

Body

{
  "updateEventData": {
    "dataUuid": "a24e9918fdf83d0aae19846bd52411e4",
    "updateMode": "OnlyOne",
    "readStatus": "Read"
  },
  "systemTags": [],
  "userTags": []
}

上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"updateEventData":{"dataUuid":"a24e9918fdf83d0aae19846bd52411e4","updateMode":"OnlyOne","readStatus":"Read"}}' http://localhost:8080/zstack/v1/zwatch/events/actions

参数列表

名字	类型	位置	描述	可选值	起始版本
dataUuid (可选)	String	body(包含在updateEventData结构中)	资源的UUID，唯一标示该资源		3.3.0
dataStartTime (可选)	Long	body(包含在updateEventData结构中)	选择目标消息的起始时间，updateMode需要传入InRange		3.3.0
dataEndTime (可选)	Long	body(包含在updateEventData结构中)	选择目标消息的结束时间，updateMode需要传入InRange		3.3.0
updateMode	String	body(包含在updateEventData结构中)	选择更新目标消息的范围，OnlyOne表示只更新指定的消息，InRange表示更新某个时间范围产生的消息， All表示更新所有消息	OnlyOne InRange All	3.3.0
readStatus (可选)	String	body(包含在updateEventData结构中)	更新消息已读状态	Read Unread	3.3.0
systemTags (可选)	List	body	系统标签		3.3.0
userTags (可选)	List	body	用户标签		3.3.0

API返回

该API成功时返回一个空的JSON结构{}，出错时返回的JSON结构包含一个error字段，例如：

{
  "error": {
    "code": "SYS.1001",
    "description": "A message or a operation timeout",
    "details": "Create VM on KVM timeout after 300s"
  }
}

SDK示例

Java SDK

UpdateEventDataAction action = new UpdateEventDataAction();
action.dataUuid = "a24e9918fdf83d0aae19846bd52411e4";
action.updateMode = "OnlyOne";
action.readStatus = "Read";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
UpdateEventDataAction.Result res = action.call();

Python SDK

UpdateEventDataAction action = UpdateEventDataAction()
action.dataUuid = "a24e9918fdf83d0aae19846bd52411e4"
action.updateMode = "OnlyOne"
action.readStatus = "Read"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
UpdateEventDataAction.Result res = action.call()