报警器(Alarm)

创建报警器 (CreateAlarm)

API请求

URLs
POST zstack/v1/zwatch/alarms
Headers
Authorization: OAuth the-session-uuid
Body
{
  "params": {
    "name": "VM CPU Alarm",
    "comparisonOperator": "LessThanOrEqualTo",
    "period": 60.0,
    "namespace": "ZStack/VM",
    "metricName": "org.zstack.zwatch.datatype.Metric@53fa9b19",
    "threshold": 60.0,
    "repeatInterval": 1800.0,
    "enableRecovery": true,
    "labels": [
      {
        "key": "VMUuid",
        "value": "ca6b4ad7a0e446c6a8c4f52d93215f6e",
        "op": "Equal"
      }
    ],
    "actions": [
      {
        "actionUuid": "19b7cfaf6134408897d95588b01308fe",
        "actionType": "sns"
      }
    ],
    "repeatCount": -1.0,
    "type": "Any"
    "enableRecovery": true
  },
  "systemTags": [],
  "userTags": []
}
Note: 上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。
Curl示例
curl -H "Content-Type: application/json" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{"name":"VM CPU Alarm","comparisonOperator":"LessThanOrEqualTo","period":60.0,"namespace":"ZStack/VM","metricName":"org.zstack.zwatch.datatype.Metric@53fa9b19","threshold":60.0,"repeatInterval":1800.0,"labels":[{"key":"VMUuid","value":"61f6b705fcb944df8138ea6b52b0b4a6","op":"Equal"}],"actions":[{"actionUuid":"699541db497e4d3e9c49020c2dad8d6c","actionType":"sns"}],"repeatCount":-1.0,"type":"Any","enableRecovery":true}}' http://localhost:8080/zstack/v1/zwatch/alarms
参数列表
名字 类型 位置 描述 可选值 起始版本
name String body(包含在params结构中) 资源名称 2.3
description (可选) String body(包含在params结构中) 资源的详细描述 2.3
comparisonOperator String body(包含在params结构中) 阈值比较符
  • GreaterThanOrEqualTo
  • GreaterThan
  • LessThan
  • LessThanOrEqualTo
2.3
period(可选) Integer body(包含在params结构中) 阈值持续时间 2.3
namespace String body(包含在params结构中) 名字空间 2.3
metricName String body(包含在params结构中) 监控项名 2.3
threshold Double body(包含在params结构中) 阈值 2.3
repeatInterval (可选) Integer body(包含在params结构中) 报警重复时间 2.3
labels (可选) List body(包含在params结构中) 标签列表 2.3
actions (可选) List body(包含在params结构中) 报警动作列表 2.3
resourceUuid (可选) String body(包含在params结构中) 2.3
repeatCount (可选) Integer body(包含在params结构中) 报警重复次数 3.3.0
type (可选) String body(包含在params结构中) 报警器类型 3.3.0
systemTags (可选) List body 系统标签 2.3
userTags (可选) List body 用户标签 2.3
enableRecovery Boolean body(包含在params结构中) 开启恢复通知 3.4.0
emergencyLevel (可选) String body(包含在params结构中) 报警等级
  • Emergent
  • Important
  • Normal
3.8.0

API返回

返回示例
{
  "inventory": {
    "uuid": "6ff094db7e8b4640880751c5a17e7b63",
    "name": "VM CPU Alarm",
    "comparisonOperator": "LessThanOrEqualTo",
    "period": 60.0,
    "namespace": "ZStack/VM",
    "metricName": "org.zstack.zwatch.datatype.Metric@c2e79f0",
    "threshold": 30.0,
    "repeatInterval": 1800.0,
    "repeatCount": -1.0,
    "status": "Alarm",
    "state": "Enabled",
    "enableRecovery": true,
    "createDate": "Jul 6, 2018 1:51:02 PM",
    "lastOpDate": "Jul 6, 2018 1:51:02 PM",
    "labels": [
      {
        "uuid": "cccd980c3bb84f4486d96a960eb08edb",
        "key": "VMUuid",
        "operator": "\u003d",
        "value": "f486fd81583747459d8a6cd47f9228e5"
      }
    ],
    "actions": [
      {
        "alarmUuid": "8a6a98e3cc484388a746d725265886b3",
        "actionType": "sns",
        "actionUuid": "86a2b51fbc7f406c906711081852fa49"
      }
    ]
  }
}
名字 类型 描述 起始版本
error ErrorCode 错误码,若不为null,则表示操作失败, 操作成功时该字段为null。 详情参考error 2.3
inventory AlarmInventory 详情参考inventory 2.3
#error
名字 类型 描述 起始版本
code String 错误码号,错误的全局唯一标识,例如SYS.1000, HOST.1001 2.3
description String 错误的概要描述 2.3
details String 错误的详细信息 2.3
elaboration String 保留字段,默认为null 2.3
opaque LinkedHashMap 保留字段,默认为null 2.3
cause ErrorCode 根错误,引发当前错误的源错误,若无原错误,该字段为null 2.3
#inventory
名字 类型 描述 起始版本
uuid String 资源的UUID,唯一标示该资源 2.3
name String 资源名称 2.3
description String 资源的详细描述 2.3
period Integer 阈值持续时间 2.3
namespace String 名字空间 2.3
metricName String 监控项名称 2.3
threshold Double 阈值 2.3
repeatInterval Integer 报警重复时间 2.3
enableRecovery Boolean 开启恢复通知 3.4.0
createDate Timestamp 创建时间 2.3
lastOpDate Timestamp 最后一次修改时间 2.3
comparisonOperator ComparisonOperator 详情参考comparisonOperator 2.3
status AlarmStatus 详情参考status 2.3
labels List 详情参考labels 2.3
actions List 详情参考actions 2.3
#comparisonOperator
名字 类型 描述 起始版本
name String 资源名称 2.3
ordinal int 2.3
#status
名字 类型 描述 起始版本
OK AlarmStatus 监控中 2.3
Alarm AlarmStatus 已触发 2.3
InsufficientData AlarmStatus 数据不足 2.3
#labels
名字 类型 描述 起始版本
uuid String 资源的UUID,唯一标示该资源 2.3
key String 标签键 2.3
operator String 比较符 2.3
value String 标签值 2.3
#actions
名字 类型 描述 起始版本
alarmUuid String 报警器UUID 2.3
actionType String 报警动作类型 2.3
actionUuid String 报警动作UUID 2.3

SDK示例

Java SDK
CreateAlarmAction action = new CreateAlarmAction();
action.name = "VM CPU Alarm";
action.comparisonOperator = "LessThanOrEqualTo";
action.period = 60.0;
action.namespace = "ZStack/VM";
action.metricName = "org.zstack.zwatch.datatype.Metric@c2e79f0";
action.threshold = 60.0;
action.repeatInterval = 1800.0;
action.labels = asList([key:VMUuid, value:45821a26f579447fa77bfb82b1b0268e, op:Equal]);
action.actions = asList([actionUuid:8e06ec09862c46c3aaf9fc6337815ffb, actionType:sns]);
action.repeatCount = -1.0;
action.type = "Any";
action.enableRecovery = true;
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
CreateAlarmAction.Result res = action.call();
Python SDK
CreateAlarmAction action = CreateAlarmAction()
action.name = "VM CPU Alarm"
action.comparisonOperator = "LessThanOrEqualTo"
action.period = 60.0
action.namespace = "ZStack/VM"
action.metricName = "org.zstack.zwatch.datatype.Metric@c2e79f0"
action.threshold = 60.0
action.repeatInterval = 1800.0
action.labels = [[key:VMUuid, value:7dd44bfe750f42859528b27ef90f1412, op:Equal]]
action.actions = [[actionUuid:b1acb139666140d09f4f93b8dd96f49f, actionType:sns]]
action.repeatCount = -1.0
action.type = "Any"
action.enableRecovery = true
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
CreateAlarmAction.Result res = action.call()

删除报警器(DeleteAlarm)

API请求

URLs
DELETE zstack/v1/zwatch/alarms/{uuid}
Headers
Authorization: OAuth the-session-uuid
Curl示例
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X DELETE http://localhost:8080/zstack/v1/zwatch/alarms/2aae360b1240374696d79a0cca10bf24
参数列表
名字 类型 位置 描述 可选值 起始版本
uuid String url 资源的UUID,唯一标示该资源 2.3
deleteMode (可选) String body 2.3
systemTags (可选) List body 系统标签 2.3
userTags (可选) List body 用户标签 2.3

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
DeleteAlarmAction action = new DeleteAlarmAction();
action.uuid = "2aae360b1240374696d79a0cca10bf24";
action.deleteMode = "Permissive";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
DeleteAlarmAction.Result res = action.call();
Python SDK
DeleteAlarmAction action = DeleteAlarmAction()
action.uuid = "2aae360b1240374696d79a0cca10bf24"
action.deleteMode = "Permissive"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
DeleteAlarmAction.Result res = action.call()

修改报警器 (UpdateAlarm)

API请求

URLs
PUT zstack/v1/zwatch/alarms/{uuid}/actions
Headers
Authorization: OAuth the-session-uuid
Body
{
  "updateAlarm": {
    "name": "VM CPU Alarm",
    "comparisonOperator": "LessThanOrEqualTo",
    "period": 60.0,
    "enableRecovery": true
  },
  "systemTags": [],
  "userTags": []
}
Note: 上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。
Curl示例
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"updateAlarm":{"name":"VM CPU Alarm","comparisonOperator":"LessThanOrEqualTo","period":60.0,"enableRecovery":true}}' http://localhost:8080/zstack/v1/zwatch/alarms/28397feb3d083fdc9346edb066fbf589/actions
参数列表
名字 类型 位置 描述 可选值 起始版本
uuid String url 资源的UUID,唯一标示该资源 2.3
name (可选) String body(包含在updateAlarm结构中) 资源名称 2.3
description (可选) String body(包含在updateAlarm结构中) 资源的详细描述 2.3
comparisonOperator (可选) String body(包含在updateAlarm结构中) 阈值比较符
  • GreaterThanOrEqualTo
  • GreaterThan
  • LessThan
  • LessThanOrEqualTo
2.3
period (可选) Integer body(包含在updateAlarm结构中) 阈值持续时间 2.3
threshold (可选) Double body(包含在updateAlarm结构中) 阈值 2.3
repeatInterval (可选) Integer body(包含在updateAlarm结构中) 报警重复时间 2.3
repeatCount (可选) Integer body(包含在updateAlarm结构中) 报警重复次数 3.3.0
systemTags (可选) List body 系统标签 2.3
userTags (可选) List body 用户标签 2.3
repeatCount (可选) Integer body(包含在updateAlarm结构中) 报警重复次数 3.2
enableRecovery (可选) Boolean 开启恢复通知 3.4.0
emergencyLevel (可选) String body(包含在updateAlarm结构中) 报警等级
  • Emergent
  • Important
  • Normal
3.8.0

API返回

返回示例
{
  "inventory": {
    "uuid": "33e642a1eb3c4f27a7da7acc5891de0a",
    "name": "VM CPU Alarm",
    "comparisonOperator": "LessThanOrEqualTo",
    "period": 60.0,
    "namespace": "ZStack/VM",
    "metricName": "org.zstack.zwatch.datatype.Metric@22c0dd63",
    "threshold": 30.0,
    "repeatInterval": 1800.0,
    "repeatCount": -1.0,
    "status": "Alarm",
    "state": "Enabled",
    "createDate": "Jan 8, 2019 4:11:27 PM",
    "lastOpDate": "Jan 8, 2019 4:11:27 PM",
    "labels": [
      {
        "uuid": "c4da2db2fa454368a3a05016ae8c8070",
        "key": "VMUuid",
        "operator": "\u003d",
        "value": "396d863211e446938ea01eb10bc9fd18"
      }
    ],
    "actions": [
      {
        "alarmUuid": "0d18a844bbf544bb914ab9287651f59f",
        "actionType": "sns",
        "actionUuid": "17b884822b284e6e9a0b67307a28955c"
      }
    ]
  }
}
名字 类型 描述 起始版本
error ErrorCode 错误码,若不为null,则表示操作失败, 操作成功时该字段为null。 详情参考error 2.3
inventory AlarmInventory 详情参考inventory 2.3
#error
名字 类型 描述 起始版本
code String 错误码号,错误的全局唯一标识,例如SYS.1000, HOST.1001 2.3
description String 错误的概要描述 2.3
details String 错误的详细信息 2.3
elaboration String 保留字段,默认为null 2.3
opaque LinkedHashMap 保留字段,默认为null 2.3
cause ErrorCode 根错误,引发当前错误的源错误,若无原错误,该字段为null 2.3
#inventory
名字 类型 描述 起始版本
uuid String 资源的UUID,唯一标示该资源 2.3
name String 资源名称 2.3
description String 资源的详细描述 2.3
period Integer 阈值持续时间 2.3
namespace String 名字空间 2.3
metricName String 监控项名称 2.3
threshold Double 阈值 2.3
repeatInterval Integer 报警重复时间 2.3
enableRecovery Boolean 开启恢复通知 3.4.0
createDate Timestamp 创建时间 2.3
lastOpDate Timestamp 最后一次修改时间 2.3
comparisonOperator ComparisonOperator 详情参考comparisonOperator 2.3
status AlarmStatus 详情参考status 2.3
labels List 详情参考labels 2.3
actions List 详情参考actions 2.3
#comparisonOperator
名字 类型 描述 起始版本
name String 资源名称 2.3
ordinal int 2.3
#status
名字 类型 描述 起始版本
OK AlarmStatus 监控中 2.3
Alarm AlarmStatus 已触发 2.3
InsufficientData AlarmStatus 数据不足 2.3
#labels
名字 类型 描述 起始版本
uuid String 资源的UUID,唯一标示该资源 2.3
key String 标签键 2.3
operator String 比较符 2.3
value String 标签值 2.3
#actions
名字 类型 描述 起始版本
alarmUuid String 报警器UUID 2.3
actionType String 报警动作类型 2.3
actionUuid String 报警动作UUID 2.3

SDK示例

Java SDK
UpdateAlarmAction action = new UpdateAlarmAction();
action.uuid = "28397feb3d083fdc9346edb066fbf589";
action.name = "VM CPU Alarm";
action.comparisonOperator = "LessThanOrEqualTo";
action.period = 60.0;
action.enableRecovery = true;
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
UpdateAlarmAction.Result res = action.call();
Python SDK
UpdateAlarmAction action = UpdateAlarmAction()
action.uuid = "28397feb3d083fdc9346edb066fbf589"
action.name = "VM CPU Alarm"
action.comparisonOperator = "LessThanOrEqualTo"
action.period = 60.0
action.enableRecovery = true
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
UpdateAlarmAction.Result res = action.call()

修改事件报警器 (UpdateSubscribeEvent)

API请求

URLs
PUT zstack/v1/zwatch/events/subscriptions/{uuid}/actions
Headers
Authorization: OAuth the-session-uuid
Body
{
  "updateSubscribeEvent": {
    "emergencyLevel": "Emergent"
  },
  "systemTags": [],
  "userTags": []
}
Note: 上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。
Curl示例
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"updateSubscribeEvent":{"emergencyLevel":"Emergent"}}' http://localhost:8080/zstack/v1/zwatch/events/subscriptions/37fc1fcc0fa93fb493702469039edbfb/actions
参数列表
名字 类型 位置 描述 可选值 起始版本
uuid String url 事件报警器UUID 3.8.0
emergencyLevel (可选) String body(包含在updateSubscribeEvent结构中) 报警等级
  • Emergent
  • Important
  • Normal
3.8.0
systemTags (可选) List body 3.8.0
userTags (可选) List body 3.8.0

API返回

返回示例:
{
  "inventory": {
    "uuid": "d1b38b37691948218df07900a2c1c065",
    "name": "vm_state_change_event",
    "namespace": "ZStack/VM",
    "eventName": "org.zstack.zwatch.datatype.EventFamily@35324244",
    "state": "Enabled",
    "actions": [
      {
        "subscriptionUuid": "30d1075270c94f6e9312c1a4404cc67a",
        "actionType": "sns",
        "actionUuid": "33308113390a472286df32a99cd477ef"
      }
    ],
    "labels": [
      {
        "uuid": "26246baade39495c99d018d826ae576e",
        "key": "DestinationHostUuid",
        "operator": "Equal",
        "value": "79e249b6995a4c819d8e6cd33798135a"
      }
    ],
    "lastOpDate": "Jan 11, 2020 11:48:35 PM",
    "createDate": "Jan 11, 2020 11:48:35 PM",
    "emergencyLevel": "Emergent"
  }
}
名字 类型 描述 起始版本
error ErrorCode 错误码,若不为null,则表示操作失败, 操作成功时该字段为null。 详情参考error 3.8.0
inventory EventSubscriptionInventory 详情参考inventory 3.8.0
#error
名字 类型 描述 起始版本
code String 错误码号,错误的全局唯一标识,例如SYS.1000, HOST.1001 3.8.0
description String 错误的概要描述 3.8.0
details String 错误的详细信息 3.8.0
elaboration String 保留字段,默认为null 3.8.0
opaque LinkedHashMap 保留字段,默认为null 3.8.0
cause ErrorCode 根错误,引发当前错误的源错误,若无原错误,该字段为null 3.8.0
#inventory
名字 类型 描述 起始版本
uuid String 资源的UUID,唯一标示该资源 3.8.0
name String 资源名称 3.8.0
namespace String 名字空间 3.8.0
eventName String 事件名 3.8.0
lastOpDate Timestamp 最后一次修改时间 3.8.0
createDate Timestamp 创建时间 3.8.0
emergencyLevel String 报警等级 3.8.0
state EventSubscriptionState 详情参考state 3.8.0
actions List 详情参考actions 3.8.0
labels List 详情参考labels 3.8.0
#state
名字 类型 描述 起始版本
name String 资源名称 3.8.0
ordinal int 3.8.0
#actions
名字 类型 描述 起始版本
subscriptionUuid String 事件订阅UUID 3.8.0
actionType String 动作类型 3.8.0
actionUuid String 动作UUID 3.8.0
#labels
名字 类型 描述 起始版本
uuid String 资源的UUID,唯一标示该资源 3.8.0
key String 标签名 3.8.0
value String 标签值 3.8.0
operator Operator 详情参考operator 3.8.0
#operator
名字 类型 描述 起始版本
op String 3.8.0
name String 资源名称 3.8.0
ordinal int 3.8.0

SDK示例

Java SDK
UpdateSubscribeEventAction action = new UpdateSubscribeEventAction();
action.uuid = "37fc1fcc0fa93fb493702469039edbfb";
action.emergencyLevel = "Emergent";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
UpdateSubscribeEventAction.Result res = action.call();
Python SDK
UpdateSubscribeEventAction action = UpdateSubscribeEventAction()
action.uuid = "37fc1fcc0fa93fb493702469039edbfb"
action.emergencyLevel = "Emergent"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
UpdateSubscribeEventAction.Result res = action.call()

增加报警动作 (AddActionToAlarm)

API请求

URLs
POST zstack/v1/zwatch/alarms/{alarmUuid}/actions
Headers
Authorization: OAuth the-session-uuid
Body
{
  "params": {
    "actionUuid": "a48c9fa0454238a4b731279b92d8bad1",
    "actionType": "sns"
  },
  "systemTags": [],
  "userTags": []
}
Note: 上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。
Curl示例
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{"actionUuid":"a48c9fa0454238a4b731279b92d8bad1","actionType":"sns"}}' http://localhost:8080/zstack/v1/zwatch/alarms/3edde2bd29493568a2640f75d218ed05/actions
参数列表
名字 类型 位置 描述 可选值 起始版本
alarmUuid String url 报警器UUID 2.3
actionUuid String body(包含在params结构中) 报警动作UUID 2.3
actionType String body(包含在params结构中) 报警动作类型 2.3
systemTags (可选) List body 系统标签 2.3
userTags (可选) List body 用户标签 2.3

API返回

返回示例
{
  "inventory": {
    "uuid": "6b9ce7e8a6c04476aa22ce6c851a7f80",
    "name": "VM CPU Alarm",
    "comparisonOperator": "LessThanOrEqualTo",
    "period": 60.0,
    "namespace": "ZStack/VM",
    "metricName": "org.zstack.zwatch.datatype.Metric@565e1ebe",
    "threshold": 30.0,
    "repeatInterval": 1800.0,
    "status": "Alarm",
    "state": "Enabled",
    "createDate": "Jul 6, 2018 1:50:39 PM",
    "lastOpDate": "Jul 6, 2018 1:50:39 PM",
    "labels": [
      {
        "uuid": "f183fec66c3d40938621568943f4c0bf",
        "key": "VMUuid",
        "operator": "\u003d",
        "value": "7d46ab7f0f104ad0908f23d648bcaa9e"
      }
    ],
    "actions": [
      {
        "alarmUuid": "7379b3951c9f4c82a0571cc55ebc98b3",
        "actionType": "sns",
        "actionUuid": "27e18067eb614fd4bcb047c008e3a4c0"
      }
    ]
  }
}
名字 类型 描述 起始版本
error ErrorCode 错误码,若不为null,则表示操作失败, 操作成功时该字段为null。 详情参考error 2.3
inventory AlarmInventory 详情参考inventory 2.3
#error
名字 类型 描述 起始版本
code String 错误码号,错误的全局唯一标识,例如SYS.1000, HOST.1001 2.3
description String 错误的概要描述 2.3
details String 错误的详细信息 2.3
elaboration String 保留字段,默认为null 2.3
opaque LinkedHashMap 保留字段,默认为null 2.3
cause ErrorCode 根错误,引发当前错误的源错误,若无原错误,该字段为null 2.3
#inventory
名字 类型 描述 起始版本
uuid String 资源的UUID,唯一标示该资源 2.3
name String 资源名称 2.3
description String 资源的详细描述 2.3
period Integer 阈值持续时间 2.3
namespace String 名字空间 2.3
metricName String 监控项名称 2.3
threshold Double 阈值 2.3
repeatInterval Integer 报警重复时间 2.3
createDate Timestamp 创建时间 2.3
lastOpDate Timestamp 最后一次修改时间 2.3
comparisonOperator ComparisonOperator 详情参考comparisonOperator 2.3
status AlarmStatus 详情参考status 2.3
labels List 详情参考labels 2.3
actions List 详情参考actions 2.3
#comparisonOperator
名字 类型 描述 起始版本
name String 资源名称 2.3
ordinal int 2.3
#status
名字 类型 描述 起始版本
OK AlarmStatus 监控中 2.3
Alarm AlarmStatus 已触发 2.3
InsufficientData AlarmStatus 数据不足 2.3
#labels
名字 类型 描述 起始版本
uuid String 资源的UUID,唯一标示该资源 2.3
key String 标签键 2.3
operator String 比较符 2.3
value String 标签值 2.3
#actions
名字 类型 描述 起始版本
alarmUuid String 报警器UUID 2.3
actionType String 报警动作类型 2.3
actionUuid String 报警动作UUID 2.3

SDK示例

Java SDK
AddActionToAlarmAction action = new AddActionToAlarmAction();
action.alarmUuid = "3edde2bd29493568a2640f75d218ed05";
action.actionUuid = "a48c9fa0454238a4b731279b92d8bad1";
action.actionType = "sns";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
AddActionToAlarmAction.Result res = action.call();
Python SDK
AddActionToAlarmAction action = AddActionToAlarmAction()
action.alarmUuid = "3edde2bd29493568a2640f75d218ed05"
action.actionUuid = "a48c9fa0454238a4b731279b92d8bad1"
action.actionType = "sns"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
AddActionToAlarmAction.Result res = action.call()

删除报警动作 (RemoveActionFromAlarm)

API请求

URLs
DELETE zstack/v1/zwatch/alarms/{alarmUuid}/actions/{actionUuid}
Headers
Authorization: OAuth the-session-uuid
Curl示例
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X DELETE http://localhost:8080/zstack/v1/zwatch/alarms/2c95bdf5490131bbb421622579b59eb8/actions/41c582ab1cea31d5addd02bb00bb173d
参数列表
名字 类型 位置 描述 可选值 起始版本
alarmUuid String url 报警器UUID 2.3
actionUuid String url 报警动作UUID 2.3
deleteMode (可选) String body 2.3
systemTags (可选) List body 系统标签 2.3
userTags (可选) List body 用户标签 2.3

API返回

返回示例
{
  "inventory": {
    "uuid": "3f753a2f9dd44becb0435b2a517fd5d4",
    "name": "VM CPU Alarm",
    "comparisonOperator": "LessThanOrEqualTo",
    "period": 60.0,
    "namespace": "ZStack/VM",
    "metricName": "org.zstack.zwatch.datatype.Metric@565e1ebe",
    "threshold": 30.0,
    "repeatInterval": 1800.0,
    "status": "Alarm",
    "state": "Enabled",
    "createDate": "Jul 6, 2018 1:50:59 PM",
    "lastOpDate": "Jul 6, 2018 1:50:59 PM",
    "labels": [
      {
        "uuid": "cf7ff04d570f4f509e6b22851ceb231d",
        "key": "VMUuid",
        "operator": "\u003d",
        "value": "cda155f903f1417f951578ea74623f5e"
      }
    ],
    "actions": [
      {
        "alarmUuid": "5d2a502edc8d4c34b90ae499c7fdb437",
        "actionType": "sns",
        "actionUuid": "4b7903efe370462aab75bb5890971e6d"
      }
    ]
  }
}
名字 类型 描述 起始版本
error ErrorCode 错误码,若不为null,则表示操作失败, 操作成功时该字段为null。 详情参考error 2.3
inventory AlarmInventory 详情参考inventory 2.3
#error
名字 类型 描述 起始版本
code String 错误码号,错误的全局唯一标识,例如SYS.1000, HOST.1001 2.3
description String 错误的概要描述 2.3
details String 错误的详细信息 2.3
elaboration String 保留字段,默认为null 2.3
opaque LinkedHashMap 保留字段,默认为null 2.3
cause ErrorCode 根错误,引发当前错误的源错误,若无原错误,该字段为null 2.3
#inventory
名字 类型 描述 起始版本
uuid String 资源的UUID,唯一标示该资源 2.3
name String 资源名称 2.3
description String 资源的详细描述 2.3
period Integer 阈值持续时间 2.3
namespace String 名字空间 2.3
metricName String 监控项名称 2.3
threshold Double 阈值 2.3
repeatInterval Integer 报警重复时间 2.3
createDate Timestamp 创建时间 2.3
lastOpDate Timestamp 最后一次修改时间 2.3
comparisonOperator ComparisonOperator 详情参考comparisonOperator 2.3
status AlarmStatus 详情参考status 2.3
labels List 详情参考labels 2.3
actions List 详情参考actions 2.3
#comparisonOperator
名字 类型 描述 起始版本
name String 资源名称 2.3
ordinal int 2.3
#status
名字 类型 描述 起始版本
OK AlarmStatus 监控中 2.3
Alarm AlarmStatus 已触发 2.3
InsufficientData AlarmStatus 数据不足 2.3
#labels
名字 类型 描述 起始版本
uuid String 资源的UUID,唯一标示该资源 2.3
key String 标签键 2.3
operator String 比较符 2.3
value String 标签值 2.3
#actions
名字 类型 描述 起始版本
alarmUuid String 报警器UUID 2.3
actionType String 报警动作类型 2.3
actionUuid String 报警动作UUID 2.3

SDK示例

Java SDK
RemoveActionFromAlarmAction action = new RemoveActionFromAlarmAction();
action.alarmUuid = "2c95bdf5490131bbb421622579b59eb8";
action.actionUuid = "41c582ab1cea31d5addd02bb00bb173d";
action.deleteMode = "Permissive";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
RemoveActionFromAlarmAction.Result res = action.call();
Python SDK
RemoveActionFromAlarmAction action = RemoveActionFromAlarmAction()
action.alarmUuid = "2c95bdf5490131bbb421622579b59eb8"
action.actionUuid = "41c582ab1cea31d5addd02bb00bb173d"
action.deleteMode = "Permissive"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
RemoveActionFromAlarmAction.Result res = action.call()

增加标签到报警器(AddLabelToAlarm)

API请求

URLs
POST zstack/v1/zwatch/alarms/{alarmUuid}/labels
Headers
Authorization: OAuth the-session-uuid
Body
{
  "params": {
    "key": "VMUuid",
    "value": "2840f151485641cca48b190ebb989cbf",
    "operator": "Equal"
  },
  "systemTags": [],
  "userTags": []
}
Note: 上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。
Curl示例
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{"key":"VMUuid","value":"165af818089b4e9f8c07691de549f8d4","operator":"Equal"}}' http://localhost:8080/zstack/v1/zwatch/alarms/00b90ca9d59d3f539530fbcc8572c403/labels
参数列表
名字 类型 位置 描述 可选值 起始版本
alarmUuid String url 报警器UUID 2.3
key String body(包含在params结构中) 标签键 2.3
value String body(包含在params结构中) 标签值 2.3
operator String body(包含在params结构中) 操作符
  • Regex
  • Equal
2.3
resourceUuid (可选) String body(包含在params结构中) 2.3
systemTags (可选) List body 系统标签 2.3
userTags (可选) List body 用户标签 2.3

API返回

返回示例
{
  "inventory": {
    "uuid": "3f54b760c8d64e17bc282258335b718a",
    "key": "VMUuid",
    "operator": "\u003d",
    "value": "dd5b28c103594573b7bb21a02cb000c4"
  }
}
名字 类型 描述 起始版本
error ErrorCode 错误码,若不为null,则表示操作失败, 操作成功时该字段为null。 详情参考error 2.3
inventory AlarmInventory 详情参考inventory 2.3
#error
名字 类型 描述 起始版本
code String 错误码号,错误的全局唯一标识,例如SYS.1000, HOST.1001 2.3
description String 错误的概要描述 2.3
details String 错误的详细信息 2.3
elaboration String 保留字段,默认为null 2.3
opaque LinkedHashMap 保留字段,默认为null 2.3
cause ErrorCode 根错误,引发当前错误的源错误,若无原错误,该字段为null 2.3
#inventory
名字 类型 描述 起始版本
uuid String 资源的UUID,唯一标示该资源 2.3
name String 资源名称 2.3
description String 资源的详细描述 2.3
period Integer 阈值持续时间 2.3
namespace String 名字空间 2.3
metricName String 监控项名称 2.3
threshold Double 阈值 2.3
repeatInterval Integer 报警重复时间 2.3
createDate Timestamp 创建时间 2.3
lastOpDate Timestamp 最后一次修改时间 2.3
comparisonOperator ComparisonOperator 详情参考comparisonOperator 2.3
status AlarmStatus 详情参考status 2.3
labels List 详情参考labels 2.3
actions List 详情参考actions 2.3
#comparisonOperator
名字 类型 描述 起始版本
name String 资源名称 2.3
ordinal int 2.3
#status
名字 类型 描述 起始版本
OK AlarmStatus 监控中 2.3
Alarm AlarmStatus 已触发 2.3
InsufficientData AlarmStatus 数据不足 2.3
#labels
名字 类型 描述 起始版本
uuid String 资源的UUID,唯一标示该资源 2.3
key String 标签键 2.3
operator String 比较符 2.3
value String 标签值 2.3
#actions
名字 类型 描述 起始版本
alarmUuid String 报警器UUID 2.3
actionType String 报警动作类型 2.3
actionUuid String 报警动作UUID 2.3

SDK示例

Java SDK
AddLabelToAlarmAction action = new AddLabelToAlarmAction();
action.alarmUuid = "00b90ca9d59d3f539530fbcc8572c403";
action.key = "VMUuid";
action.value = "bfaa02ec5c37490d829ae95bebf15b78";
action.operator = "Equal";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
AddLabelToAlarmAction.Result res = action.call();
Python SDK
AddLabelToAlarmAction action = AddLabelToAlarmAction()
action.alarmUuid = "00b90ca9d59d3f539530fbcc8572c403"
action.key = "VMUuid"
action.value = "b4eb5d369bfb45719fbe862484011563"
action.operator = "Equal"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
AddLabelToAlarmAction.Result res = action.call()

修改报警器标签(UpdateAlarmLabel)

API请求

URLs
PUT zstack/v1/zwatch/alarms/labels/{uuid}/actions
Headers
Authorization: OAuth the-session-uuid
Body
{
  "updateAlarmLabel": {
    "key": "VMUuid",
    "value": "e9859e9eb51e4ea583a7c529407208a2",
    "operator": "Equal"
  },
  "systemTags": [],
  "userTags": []
}
Note: 上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。
Curl示例
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"updateAlarmLabel":{"key":"VMUuid","value":"59ab62f070784eb2b0d98f0d12386f0d","operator":"Equal"}}' http://localhost:8080/zstack/v1/zwatch/alarms/labels/3c228226ca213c18b54627668dd37d80/actions
参数列表
名字 类型 位置 描述 可选值 起始版本
uuid String url 资源的UUID,唯一标示该资源 3.3
key String body(包含在updateAlarmLabel结构中) 标签键 3.3
value String body(包含在updateAlarmLabel结构中) 标签值 3.3
operator String body(包含在updateAlarmLabel结构中) 标签操作符
  • Regex
  • Equal
3.3
systemTags (可选) List body 系统标签 3.3
userTags (可选) List body 用户标签 3.3

API返回

返回示例
{
  "inventory": {
    "uuid": "5ea6d350f0e64d0b9467d033e9c6d052",
    "key": "VMUuid",
    "operator": "\u003d",
    "value": "35956236f261467cb2cef1db8626024e"
  }
}
名字 类型 描述 起始版本
error ErrorCode 错误码,若不为null,则表示操作失败, 操作成功时该字段为null。 详情参考error 3.3.0
inventory AlarmLabelInventory 详情参考inventory 3.3.0
#error
名字 类型 描述 起始版本
code String 错误码号,错误的全局唯一标识,例如SYS.1000, HOST.1001 3.3.0
description String 错误的概要描述 3.3.0
details String 错误的详细信息 3.3.0
elaboration String 保留字段,默认为null 3.3.0
opaque LinkedHashMap 保留字段,默认为null 3.3.0
cause ErrorCode 根错误,引发当前错误的源错误,若无原错误,该字段为null 3.3.0
#inventory
名字 类型 描述 起始版本
uuid String 资源的UUID,唯一标示该资源 3.3.0
key String 3.3.0
operator String 3.3.0
value String 3.3.0

SDK示例

Java SDK
UpdateAlarmLabelAction action = new UpdateAlarmLabelAction();
action.uuid = "3c228226ca213c18b54627668dd37d80";
action.key = "VMUuid";
action.value = "1a33d5ce225241e0b2cbc80123e36351";
action.operator = "Equal";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
UpdateAlarmLabelAction.Result res = action.call();
Python SDK
UpdateAlarmLabelAction action = UpdateAlarmLabelAction()
action.uuid = "3c228226ca213c18b54627668dd37d80"
action.key = "VMUuid"
action.value = "20034c6b21a24918912857c8ed923c6b"
action.operator = "Equal"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
UpdateAlarmLabelAction.Result res = action.call()

从报警器上删除标签 (RemoveLabelFromAlarm)

API请求

URLs
DELETE zstack/v1/zwatch/alarms/labels/{uuid}
Headers
Authorization: OAuth the-session-uuid
Curl示例
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X DELETE http://localhost:8080/zstack/v1/zwatch/alarms/labels/160037fc792d3815ba25fe8a48d1b237
参数列表
名字 类型 位置 描述 可选值 起始版本
uuid String url 资源的UUID,唯一标示该资源 2.3
deleteMode (可选) String body 2.3
systemTags (可选) List body 系统标签 2.3
userTags (可选) List body 用户标签 2.3

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
RemoveLabelFromAlarmAction action = new RemoveLabelFromAlarmAction();
action.uuid = "160037fc792d3815ba25fe8a48d1b237";
action.deleteMode = "Permissive";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
RemoveLabelFromAlarmAction.Result res = action.call();
Python SDK
RemoveLabelFromAlarmAction action = RemoveLabelFromAlarmAction()
action.uuid = "160037fc792d3815ba25fe8a48d1b237"
action.deleteMode = "Permissive"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
RemoveLabelFromAlarmAction.Result res = action.call()

更改报警器状态 (ChangeAlarmState)

API请求

URLs
PUT zstack/v1/zwatch/alarms/{uuid}/actions
Headers
Authorization: OAuth the-session-uuid
Body
{
  "changeAlarmState": {
    "stateEvent": "disable"
  },
  "systemTags": [],
  "userTags": []
}
Note: 上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。
Curl示例
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"changeAlarmState":{"stateEvent":"disable"}}' http://localhost:8080/zstack/v1/zwatch/alarms/226149ca389f387e95d0f671bd6b551f/actions
参数列表
名字 类型 位置 描述 可选值 起始版本
uuid String url 资源的UUID,唯一标示该资源 2.3
stateEvent String body(包含在changeAlarmState结构中) 状态事件
  • enabled
  • disabled
2.3
systemTags (可选) List body 系统标签 2.3
userTags (可选) List body 用户标签 2.3

API返回

返回示例
{
  "inventory": {
    "uuid": "3b57de3128b545a18bb7da2f086f6362",
    "name": "VM CPU Alarm",
    "comparisonOperator": "LessThanOrEqualTo",
    "period": 60.0,
    "namespace": "ZStack/VM",
    "metricName": "org.zstack.zwatch.datatype.Metric@565e1ebe",
    "threshold": 30.0,
    "repeatInterval": 1800.0,
    "status": "Alarm",
    "state": "Enabled",
    "createDate": "Jul 6, 2018 1:50:57 PM",
    "lastOpDate": "Jul 6, 2018 1:50:57 PM",
    "labels": [
      {
        "uuid": "61f43f3a05f74ef39b5b2c30354a5246",
        "key": "VMUuid",
        "operator": "\u003d",
        "value": "23958e475ae34735a4ca0b808df0cf50"
      }
    ],
    "actions": [
      {
        "alarmUuid": "f01eb4d0ec1d4cdc81dc478c87f9fceb",
        "actionType": "sns",
        "actionUuid": "c9d79c14e37a4ebb83cf0d76fb7b8dbc"
      }
    ]
  }
}
名字 类型 描述 起始版本
error ErrorCode 错误码,若不为null,则表示操作失败, 操作成功时该字段为null。 详情参考error 2.3
inventory AlarmInventory 详情参考inventory 2.3
#error
名字 类型 描述 起始版本
code String 错误码号,错误的全局唯一标识,例如SYS.1000, HOST.1001 2.3
description String 错误的概要描述 2.3
details String 错误的详细信息 2.3
elaboration String 保留字段,默认为null 2.3
opaque LinkedHashMap 保留字段,默认为null 2.3
cause ErrorCode 根错误,引发当前错误的源错误,若无原错误,该字段为null 2.3
#inventory
名字 类型 描述 起始版本
uuid String 资源的UUID,唯一标示该资源 2.3
name String 资源名称 2.3
description String 资源的详细描述 2.3
period Integer 阈值持续时间 2.3
namespace String 名字空间 2.3
metricName String 监控项名称 2.3
threshold Double 阈值 2.3
repeatInterval Integer 报警重复时间 2.3
createDate Timestamp 创建时间 2.3
lastOpDate Timestamp 最后一次修改时间 2.3
comparisonOperator ComparisonOperator 详情参考comparisonOperator 2.3
status AlarmStatus 详情参考status 2.3
labels List 详情参考labels 2.3
actions List 详情参考actions 2.3
#comparisonOperator
名字 类型 描述 起始版本
name String 资源名称 2.3
ordinal int 2.3
#status
名字 类型 描述 起始版本
OK AlarmStatus 监控中 2.3
Alarm AlarmStatus 已触发 2.3
InsufficientData AlarmStatus 数据不足 2.3
#labels
名字 类型 描述 起始版本
uuid String 资源的UUID,唯一标示该资源 2.3
key String 标签键 2.3
operator String 比较符 2.3
value String 标签值 2.3
#actions
名字 类型 描述 起始版本
alarmUuid String 报警器UUID 2.3
actionType String 报警动作类型 2.3
actionUuid String 报警动作UUID 2.3

SDK示例

Java SDK
ChangeAlarmStateAction action = new ChangeAlarmStateAction();
action.uuid = "226149ca389f387e95d0f671bd6b551f";
action.stateEvent = "disable";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
ChangeAlarmStateAction.Result res = action.call();
Python SDK
ChangeAlarmStateAction action = ChangeAlarmStateAction()
action.uuid = "226149ca389f387e95d0f671bd6b551f"
action.stateEvent = "disable"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
ChangeAlarmStateAction.Result res = action.call()

查询报警器 (QueryAlarm)

API请求

URLs
GET zstack/v1/zwatch/alarms
GET zstack/v1/zwatch/alarms/{uuid}
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/alarms?q=name=VM
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/zwatch/alarms/572c61c4a1393b6ebce520a0102dc46c

可查询字段

运行CLI命令行工具,输入QueryAlarm并按Tab键查看所有可查询字段以及可跨表查询的资源名。

API返回

返回示例
{
  "inventories": [
    {
      "uuid": "5c9ef4b25c2a485da77eab50745d53cf",
      "name": "VM CPU Alarm",
      "comparisonOperator": "LessThanOrEqualTo",
      "period": 60.0,
      "namespace": "ZStack/VM",
      "metricName": "org.zstack.zwatch.datatype.Metric@565e1ebe",
      "threshold": 30.0,
      "repeatInterval": 1800.0,
      "status": "Alarm",
      "state": "Enabled",
      "createDate": "Jul 6, 2018 1:50:51 PM",
      "lastOpDate": "Jul 6, 2018 1:50:51 PM",
      "labels": [
        {
          "uuid": "5ab29656f8df43a3a78d672af8940896",
          "key": "VMUuid",
          "operator": "\u003d",
          "value": "b128326b8b944c0499992c00cabd4711"
        }
      ],
      "actions": [
        {
          "alarmUuid": "2028f51e88b6449fb33442215810845f",
          "actionType": "sns",
          "actionUuid": "9486671b2f4c4413976f1d6938ac1d01"
        }
      ]
    }
  ]
}
名字 类型 描述 起始版本
error ErrorCode 错误码,若不为null,则表示操作失败, 操作成功时该字段为null。 详情参考error 2.3
inventories List 详情参考inventories 2.3
#error
名字 类型 描述 起始版本
code String 错误码号,错误的全局唯一标识,例如SYS.1000, HOST.1001 2.3
description String 错误的概要描述 2.3
details String 错误的详细信息 2.3
elaboration String 保留字段,默认为null 2.3
opaque LinkedHashMap 保留字段,默认为null 2.3
cause ErrorCode 根错误,引发当前错误的源错误,若无原错误,该字段为null 2.3
#inventories
名字 类型 描述 起始版本
uuid String 资源的UUID,唯一标示该资源 2.3
name String 资源名称 2.3
description String 资源的详细描述 2.3
period Integer 阈值持续时间 2.3
namespace String 名字空间 2.3
metricName String 监控项名称 2.3
threshold Double 阈值 2.3
repeatInterval Integer 报警重复时间 2.3
createDate Timestamp 创建时间 2.3
lastOpDate Timestamp 最后一次修改时间 2.3
comparisonOperator ComparisonOperator 详情参考comparisonOperator 2.3
status AlarmStatus 详情参考status 2.3
labels List 详情参考labels 2.3
actions List 详情参考actions 2.3
#comparisonOperator
名字 类型 描述 起始版本
name String 资源名称 2.3
ordinal int 2.3
#status
名字 类型 描述 起始版本
OK AlarmStatus 监控中 2.3
Alarm AlarmStatus 已触发 2.3
InsufficientData AlarmStatus 数据不足 2.3
#labels
名字 类型 描述 起始版本
uuid String 资源的UUID,唯一标示该资源 2.3
key String 标签键 2.3
operator String 比较符 2.3
value String 标签值 2.3
#actions
名字 类型 描述 起始版本
alarmUuid String 报警器UUID 2.3
actionType String 报警动作类型 2.3
actionUuid String 报警动作UUID 2.3

SDK示例

Java SDK
QueryAlarmAction action = new QueryAlarmAction();
action.conditions = asList("name=VM");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
QueryAlarmAction.Result res = action.call();
Python SDK
QueryAlarmAction action = QueryAlarmAction()
action.conditions = ["name=VM"]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
QueryAlarmAction.Result res = action.call()

获取资源报警器历史(GetAlarmData)

API请求

URLs
GET zstack/v1/zwatch/alarm-histories
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/alarm-histories?startTime=1.596444525E9&endTime=1.596530925E9&limit=200.0&count=false&excludeOtherAccount=false&start=0.0
参数列表
名字 类型 位置 描述 可选值 起始版本
startTime (可选) Long query 起始时间 2.3
endTime (可选) Long query 结束时间 2.3
limit (可选) Integer query 返回记录条数数量 2.3
conditions (可选) List query 条件列表,用于过滤结果 2.3
count (可选) boolean query 是否查询消息数量 3.3.0
excludeOtherAccount (可选) boolean query 是否排除非当前账号的消息(只对SystemAdmin生效) 3.3.0
endpointUuid (可选) String query 接收端Uuid 3.10.0
systemTags (可选) List query 系统标签 2.3
userTags (可选) List query 用户标签 2.3

API返回

返回示例
{
  "histories": [
    {
      "alarmUuid": "143b24a12d193c1992c4774dc3b34fda",
      "namespace": "ZStack/VM",
      "metricName": "CPUUsedUtilization",
      "accountUuid": "90aea7a1dfe93cf7bd3379254dddbdf9",
      "resourceUuid": "4e6bb5390d3938cb9ce830a4766ee4d8",
      "resourceType": "VmInstanceVO",
      "alarmStatus": "Alarm",
      "alarmName": "test-alarm",
      "threshold": 90.0,
      "labels": "VMUuid Equal 4e6bb5390d3938cb9ce830a4766ee4d8, CPUNum Equal 2",
      "metricValue": 10.0,
      "comparisonOperator": "LessThan",
      "time": 1.510669257141E12
    }
  ]
}
名字 类型 描述 起始版本
error ErrorCode 错误码,若不为null,则表示操作失败, 操作成功时该字段为null。 详情参考error 2.3
histories List 详情参考histories 2.3
#error
名字 类型 描述 起始版本
code String 错误码号,错误的全局唯一标识,例如SYS.1000, HOST.1001 2.3
description String 错误的概要描述 2.3
details String 错误的详细信息 2.3
elaboration String 保留字段,默认为null 2.3
opaque LinkedHashMap 保留字段,默认为null 2.3
cause ErrorCode 根错误,引发当前错误的源错误,若无原错误,该字段为null 2.3
#histories
名字 类型 描述 起始版本
alarmUuid String 报警器UUID 2.3
namespace String 名字空间名称 2.3
metricName String 监控项名称 2.3
accountUuid String 账户UUID 2.3
resourceUuid String 资源UUID 2.3
resourceType String 资源类型 2.3
alarmStatus String 报警器状态 2.3
alarmName String 报警器名称 2.3
threshold Double 报警阈值 2.3
period Integer 阈值持续周期 2.3
labels String 标签列表 2.3
metricValue Double 监控项当时值 2.3
time long 报警纪录生成时间 2.3

SDK示例

Java SDK
GetAlarmDataAction action = new GetAlarmDataAction();
action.startTime = 1.530856218E9;
action.endTime = 1.530942618E9;
action.limit = 200.0;
action.count = false;
action.excludeOtherAccount = false;
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
GetAlarmDataAction.Result res = action.call();
Python SDK
GetAlarmDataAction action = GetAlarmDataAction()
action.startTime = 1.530856218E9
action.endTime = 1.530942618E9
action.limit = 200.0
action.count = false;
action.excludeOtherAccount = false;
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
GetAlarmDataAction.Result res = action.call()

更新报警器历史消息(UpdateAlarmData)

API请求

URLs
PUT zstack/v1/zwatch/alarm-histories/actions
Headers
Authorization: OAuth the-session-uuid
Body
{
  "updateAlarmData": {
    "dataUuid": "514d4a1ed3573bf8a14ac350de0a2513",
    "updateMode": "OnlyOne",
    "readStatus": "Read"
  },
  "systemTags": [],
  "userTags": []
}
Note: 上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。
Curl示例
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"updateAlarmData":{"dataUuid":"514d4a1ed3573bf8a14ac350de0a2513","updateMode":"OnlyOne","readStatus":"Read"}}' http://localhost:8080/zstack/v1/zwatch/alarm-histories/actions
参数列表
名字 类型 位置 描述 可选值 起始版本
dataUuid (可选) String body(包含在updateAlarmData结构中) 资源的UUID,唯一标示该资源 3.3.0
dataStartTime (可选) Long body(包含在updateAlarmData结构中) 选择目标消息的起始时间,updateMode需要传入InRange 3.3.0
dataEndTime (可选) Long body(包含在updateAlarmData结构中) 选择目标消息的结束时间,updateMode需要传入InRange 3.3.0
updateMode String body(包含在updateAlarmData结构中) 选择更新目标消息的范围,OnlyOne表示只更新指定的消息,InRange表示更新某个时间范围产生的消息, All表示更新所有消息
  • OnlyOne
  • InRange
  • All
3.3.0
readStatus (可选) String body(包含在updateAlarmData结构中) 更新消息已读状态
  • 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
UpdateAlarmDataAction action = new UpdateAlarmDataAction();
action.dataUuid = "514d4a1ed3573bf8a14ac350de0a2513";
action.updateMode = "OnlyOne";
action.readStatus = "Read";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
UpdateAlarmDataAction.Result res = action.call();
Python SDK
UpdateAlarmDataAction action = UpdateAlarmDataAction()
action.dataUuid = "514d4a1ed3573bf8a14ac350de0a2513"
action.updateMode = "OnlyOne"
action.readStatus = "Read"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
UpdateAlarmDataAction.Result res = action.call()

统计报警消息数量(GetZWatchAlertHistogram)

API请求

URLs
GET zstack/v1/zwatch/alert-histories/histogram
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/alert-histories/histogram?startTime=1.623414899E9&endTime=1.623501299E9&intervalHours=8.0&groupColumns=emergencyLevel
参数列表
名字 类型 位置 描述 可选值 起始版本
tableName String query 消息类型 4.1.0
startTime Long query 起始时间 4.1.0
endTime Long query 结束时间 4.1.0
intervalHours String query 间隔小时 4.1.0
groupColumns (可选) List query 分组属性 4.1.0
systemTags (可选) List query 系统标签 4.1.0
userTags (可选) List query 用户标签 4.1.0

API返回

返回示例
{
  "histograms": [
    {
      "time": 1.510669257141E12,
      "count": 50.0,
      "tags": [
        {
          "name": "emergencyLevel",
          "value": "Emergent"
        }
      ]
    }
  ]
}
名字 类型 描述 起始版本
success boolean 4.1.0
error ErrorCode 错误码,若不为null,则表示操作失败, 操作成功时该字段为null。 详情参考error 4.1.0
histograms List 4.1.0
#error
名字 类型 描述 起始版本
code String 错误码号,错误的全局唯一标识,例如SYS.1000, HOST.1001 4.1.0
description String 错误的概要描述 4.1.0
details String 错误的详细信息 4.1.0
elaboration String 保留字段,默认为null 4.1.0
opaque LinkedHashMap 保留字段,默认为null 4.1.0
cause ErrorCode 根错误,引发当前错误的源错误,若无原错误,该字段为null 4.1.0
#histories
名字 类型 描述 起始版本
time long 时间 4.1.0
count long 数量 4.1.0
tags List 详情参考tags 4.1.0
#tags
名字 类型 描述 起始版本
name String tag名称 4.1.0
value String tag值 4.1.0

SDK示例

Java SDK
GetZWatchAlertHistogramAction action = new GetZWatchAlertHistogramAction();
action.startTime = 1.623414899E9;
action.endTime = 1.623501299E9;
action.intervalHours = 8.0;
action.groupColumns = asList("emergencyLevel");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
GetZWatchAlertHistogramAction.Result res = action.call();
Python SDK
GetZWatchAlertHistogramAction action = GetZWatchAlertHistogramAction()
action.startTime = 1.623414899E9
action.endTime = 1.623501299E9
action.intervalHours = 8.0
action.groupColumns = [emergencyLevel]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
GetZWatchAlertHistogramAction.Result res = action.call()

查询资源报警器报警记录(QueryAlarmRecord)

API请求

URLs
GET zstack/v1/zwatch/alarm-records
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/alarm-records?q=dataUuid=f30e0a92898a3cf39b98c7b20d5d09d7

可查询字段

运行CLI命令行工具,输入QueryAlarmRecord并按Tab键查看所有可查询字段以及可跨表查询的资源名。

API返回

返回示例
{
  "inventories": [
    {
      "id": 1.0,
      "createTime": 1.510669257141E12,
      "accountUuid": "ce8e0ae7bfb93fb09c3339443fb79b5a",
      "alarmName": "ZStack Primary Storage Physical Available Capacity Alarm",
      "alarmStatus": "Alarm",
      "alarmUuid": "701f9528318737bb9db81c4f9b5721a7",
      "comparisonOperator": "LessThan",
      "context": "{\"PrimaryStorageType\":\"LocalStorage\"}",
      "dataUuid": "2e6afdb668443ef9a9a82fcba794d21b",
      "emergencyLevel": "Emergent",
      "metricName": "AvailablePhysicalCapacityInPercent",
      "metricValue": 20.0,
      "namespace": "ZStack/PrimaryStorage",
      "period": 600.0,
      "readStatus": false,
      "resourceUuid": "8a596bd1689c3e83a408c2713d99fc6e",
      "threshold": 21.0
    }
  ]
}
名字 类型 描述 起始版本
error ErrorCode 错误码,若不为null,则表示操作失败, 操作成功时该字段为null。 详情参考error 4.1.0
histograms List 4.1.0
#error
名字 类型 描述 起始版本
code String 错误码号,错误的全局唯一标识,例如SYS.1000, HOST.1001 4.1.0
description String 错误的概要描述 4.1.0
details String 错误的详细信息 4.1.0
elaboration String 保留字段,默认为null 4.1.0
opaque LinkedHashMap 保留字段,默认为null 4.1.0
cause ErrorCode 根错误,引发当前错误的源错误,若无原错误,该字段为null 4.1.0
#inventories
名字 类型 描述 起始版本
id long 消息ID 4.1.0
createTime long 创建时间 4.1.0
accountUuid String 账户UUID 4.1.0
alarmName String 报警器名称 4.1.0
alarmStatus String 报警状态 4.1.0
alarmUuid String 报警器UUID 4.1.0
comparisonOperator String 阈值比较符 4.1.0
context String 内容 4.1.0
dataUuid String 消息UUID 4.1.0
emergencyLevel String 报警等级 4.1.0
labels String 标签列表 4.1.0
metricName String 监控项名称 4.1.0
metricValue Double 监控项值 4.1.0
namespace String 名字空间 4.1.0
period int 阈值持续时间 4.1.0
readStatus Boolean 已读状态 4.1.0
resourceUuid String 资源UUID 4.1.0
threshold Double 阈值 4.1.0

SDK示例

Java SDK
QueryAlarmRecordAction action = new QueryAlarmRecordAction();
action.conditions = asList("dataUuid=8860f33a964e3141aee2c3ffde2918b7");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
QueryAlarmRecordAction.Result res = action.call();
Python SDK
QueryAlarmRecordAction action = QueryAlarmRecordAction()
action.conditions = ["dataUuid=a83224ddc145340b9b7b12170ba614ba"]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
QueryAlarmRecordAction.Result res = action.call()

修改一键报警模板(UpdateActiveAlarmTemplate)

API请求

URLs
PUT zstack/v1/zwatch/activealarms/templates/{uuid}/actions
Headers
Authorization: OAuth the-session-uuid
Body
{
  "updateActiveAlarmTemplate": {
    "alarmName": "VM-CPUAverageUsedUtilization",
    "comparisonOperator": "LessThanOrEqualTo",
    "period": 60,
    "threshold": 80.0,
    "repeatInterval": 1800,
    "repeatCount": -1,
    "emergencyLevel": "Emergent"
  },
  "systemTags": [],
  "userTags": []
}
Note: 上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。
Curl示例
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"updateActiveAlarmTemplate":{"alarmName":"VM-CPUAverageUsedUtilization","comparisonOperator":"LessThanOrEqualTo","period":60,"threshold":80.0,"repeatInterval":1800,"repeatCount":-1,"emergencyLevel":"Emergent"}}' http://localhost:8080/zstack/v1/zwatch/activealarms/templates/c3e82dade74732009d5f4fd0b462f65d/actions
参数列表
名字 类型 位置 描述 可选值 起始版本
uuid String url 模板UUID 4.7.0
alarmName (可选) String body (包含在updateActiveAlarmTemplate结构中) 模板名称 4.7.0
comparisonOperator (可选) String body (包含在updateActiveAlarmTemplate结构中) 阈值比较符
  • GreaterThanOrEqualTo
  • GreaterThan
  • LessThan
  • LessThanOrEqualTo
4.7.0
period (可选) Integer body (包含在updateActiveAlarmTemplate结构中) 阈值持续时间 4.7.0
threshold (可选) Double body (包含在updateActiveAlarmTemplate结构中) 阈值 4.7.0
repeatInterval (可选) Integer body (包含在updateActiveAlarmTemplate结构中) 报警重复时间 4.7.0
repeatCount (可选) Integer body (包含在updateActiveAlarmTemplate结构中) 报警重复次数 4.7.0
emergencyLevel (可选) String body (包含在updateActiveAlarmTemplate结构中) 报警等级
  • Emergent
  • Important
  • Normal
4.7.0
labels (可选) String body (包含在updateActiveAlarmTemplate结构中) 4.7.0
systemTags (可选) List body 系统标签 4.7.0
userTags (可选) List body 用户标签 4.7.0

API返回

返回示例
{
  "inventory": {
    "uuid": "ea8aa7b6b2e43d4a9f3a19ba121ab72a",
    "alarmName": "VM CPU Alarm",
    "comparisonOperator": "LessThanOrEqualTo",
    "period": 60,
    "repeatInterval": 60,
    "repeatCount": -1,
    "namespace": "zstack/VM",
    "metricName": "CPUIdleUtilization",
    "threshold": 30.0,
    "emergencyLevel": "Emergent",
    "labels": "[{\"uuid\":\"48cc4d3273a249009ea2166b71495785\",\"key\":\"VMUuid\",\"operator\":\"\u003d\",\"value\":\"c69d93586ca349b9a3bc074e2739e20a\"}]",
    "createDate": "Nov 14, 2017 10:20:57 PM",
    "lastOpDate": "Nov 14, 2017 10:20:57 PM"
  }
}
名字 类型 描述 起始版本
success boolean 4.7.0
inventory ActiveAlarmTemplateInventory 详情参考inventory 4.7.0
error ErrorCode 错误码,若不为null,则表示操作失败, 操作成功时该字段为null。 详情参考error 4.7.0
#inventory
名字 类型 描述 起始版本
uuid String 资源的UUID,唯一标示该资源 4.7.0
alarmName String 4.7.0
period int 4.7.0
repeatInterval int 4.7.0
repeatCount int 4.7.0
namespace String 4.7.0
metricName String 4.7.0
threshold double 4.7.0
labels String 4.7.0
createDate Timestamp 创建时间 4.7.0
lastOpDate Timestamp 最后一次修改时间 4.7.0
comparisonOperator ComparisonOperator 详情参考comparisonOperator 4.7.0
emergencyLevel EmergencyLevel 详情参考emergencyLevel 4.7.0
#comparisonOperator
名字 类型 描述 起始版本
GreaterThanOrEqualTo ComparisonOperator 4.7.0
GreaterThan ComparisonOperator 4.7.0
LessThan ComparisonOperator 4.7.0
LessThanOrEqualTo ComparisonOperator 4.7.0
#emergencyLevel
名字 类型 描述 起始版本
Emergent EmergencyLevel 4.7.0
Important EmergencyLevel 4.7.0
Normal EmergencyLevel 4.7.0
#error
名字 类型 描述 起始版本
code String 错误码号,错误的全局唯一标识,例如SYS.1000, HOST.1001 4.7.0
description String 错误的概要描述 4.7.0
details String 错误的详细信息 4.7.0
elaboration String 保留字段,默认为null 4.7.0
opaque LinkedHashMap 保留字段,默认为null 4.7.0
cause ErrorCode 根错误,引发当前错误的源错误,若无原错误,该字段为null 4.7.0

SDK示例

Java SDK
UpdateActiveAlarmTemplateAction action = new UpdateActiveAlarmTemplateAction();
action.uuid = "c3e82dade74732009d5f4fd0b462f65d";
action.alarmName = "VM-CPUAverageUsedUtilization";
action.comparisonOperator = "LessThanOrEqualTo";
action.period = 60;
action.threshold = 80.0;
action.repeatInterval = 1800;
action.repeatCount = -1;
action.emergencyLevel = "Emergent";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
UpdateActiveAlarmTemplateAction.Result res = action.call();
Python SDK
UpdateActiveAlarmTemplateAction action = UpdateActiveAlarmTemplateAction()
action.uuid = "c3e82dade74732009d5f4fd0b462f65d"
action.alarmName = "VM-CPUAverageUsedUtilization"
action.comparisonOperator = "LessThanOrEqualTo"
action.period = 60
action.threshold = 80.0
action.repeatInterval = 1800
action.repeatCount = -1
action.emergencyLevel = "Emergent"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
UpdateActiveAlarmTemplateAction.Result res = action.call()

修改事件报警器状态(ChangeEventSubscriptionState)

API请求

URLs
PUT zstack/v1/zwatch/change/eventSubscription/{uuid}/state
Headers
Authorization: OAuth the-session-uuid
Body
{
  "changeEventSubscriptionState": {
    "state": "Disabled"
  },
  "systemTags": [],
  "userTags": []
}
Note: 上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。
Curl示例
curl -H "Content-Type: application/json;charset=UTF-8" /
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" /
-X PUT -d '{"changeEventSubscriptionState":{"state":"Disabled"}}' http://localhost:8080/zstack/v1/zwatch/change/eventSubscription/2140655d1d183a6690c0eecdbc721ec0/state
参数列表
名字 类型 位置 描述 可选值 起始版本
uuid String url 资源的UUID,唯一标示该资源 4.7.0
state String body (包含在changeEventSubscriptionState结构中) 事件报警器状态
  • Enabled
  • Disabled
4.7.0
systemTags (可选) List body 系统标签 4.7.0
userTags (可选) List body 用户标签 4.7.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
ChangeEventSubscriptionStateAction action = new ChangeEventSubscriptionStateAction();
action.uuid = "2140655d1d183a6690c0eecdbc721ec0";
action.state = "Disabled";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
ChangeEventSubscriptionStateAction.Result res = action.call();
Python SDK
ChangeEventSubscriptionStateAction action = ChangeEventSubscriptionStateAction()
action.uuid = "2140655d1d183a6690c0eecdbc721ec0"
action.state = "Disabled"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
ChangeEventSubscriptionStateAction.Result res = action.call()
开发手册 | ZStack ZSphere · ZVF | ZStack 资源中心