Query Alarm

GET/zstack/v1/zwatch/alarms

GET/zstack/v1/zwatch/alarms/{uuid}

Headers

Authorization: OAuth the-session-uuid

Curl Example

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

Queryable Fields

Run the CLI command-line tool, enter QueryAlarm and press Tab to view all queryable fields and cross-table queryable resource names.

API Response

Response Example

{
  "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": "=",
          "value": "b128326b8b944c0499992c00cabd4711"
        }
      ],
      "actions": [
        {
          "alarmUuid": "2028f51e88b6449fb33442215810845f",
          "actionType": "sns",
          "actionUuid": "9486671b2f4c4413976f1d6938ac1d01"
        }
      ]
    }
  ]
}

Name	Type	Description	Starting Version
error	ErrorCode	The error code. If not null, the operation failed. This field is null on success. See error for details.	2.3
inventories	List	See inventories for details.	2.3

error

Name	Type	Description	Starting Version
code	String	The error code number. A globally unique identifier for the error, for example, SYS.1000, HOST.1001.	2.3
description	String	A brief description of the error.	2.3
details	String	Detailed information about the error.	2.3
elaboration	String	A reserved field. Default is null.	2.3
opaque	LinkedHashMap	A reserved field. Default is null.	2.3
cause	ErrorCode	The root error. The source error that caused the current error. This field is null if there is no root error.	2.3

inventories

Name	Type	Description	Starting Version
uuid	String	The UUID of the resource. Uniquely identifies the resource.	2.3
name	String	Resource name.	2.3
description	String	Detailed description of the resource.	2.3
period	Integer	Threshold duration.	2.3
namespace	String	Namespace.	2.3
metricName	String	Metric name.	2.3
threshold	Double	Threshold.	2.3
repeatInterval	Integer	Alarm repeat interval.	2.3
createDate	Timestamp	Creation time.	2.3
lastOpDate	Timestamp	Last modification time.	2.3
comparisonOperator	ComparisonOperator	See comparisonOperator for details.	2.3
status	AlarmStatus	See status for details.	2.3
labels	List	See labels for details.	2.3
actions	List	See actions for details.	2.3

comparisonOperator

Name	Type	Description	Starting Version
name	String	Resource name.	2.3
ordinal	int		2.3

status

Name	Type	Description	Starting Version
OK	AlarmStatus	Monitoring.	2.3
Alarm	AlarmStatus	Triggered.	2.3
InsufficientData	AlarmStatus	Insufficient data.	2.3

labels

Name	Type	Description	Starting Version
uuid	String	The UUID of the resource. Uniquely identifies the resource.	2.3
key	String	Label key.	2.3
operator	String	Comparison operator.	2.3
value	String	Label value.	2.3

actions

Name	Type	Description	Starting Version
alarmUuid	String	Alarm UUID.	2.3
actionType	String	Alarm action type.	2.3
actionUuid	String	Alarm action UUID.	2.3

SDK Examples

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()