RemoveActionFromAlarm
API Request
URLs
DELETE zstack/v1/zwatch/alarms/{alarmUuid}/actions/{actionUuid}
Headers
Authorization: OAuth the-session-uuid
Curl
Sample
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
Request Parameters
Name | Type | Location | Description | Optional Value | Starting Version |
---|---|---|---|---|---|
alarmUuid | String | url | The alarm UUID. | 2.3 | |
actionUuid | String | url | The action UUID. | 2.3 | |
deleteMode | String | body | Optional. The delete mode. | 2.3 | |
systemTags | List | body | Optional. The system tags. | 2.3 | |
userTags | List | body | Optional. The user tags. | 2.3 |
API Response
Sample
Response
{
"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"
}
]
}
}
Name | Type | Description | Starting Version |
---|---|---|---|
error | ErrorCode | The error code. If not null, the operation fails, or vice versa. For more information, see error. | 2.3 |
inventory | AlarmInventory | See inventory. | 2.3 |
#error
Name | Type | Description | Starting Version |
---|---|---|---|
code | String | The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001. | 2.3 |
description | String | The brief description of the error. | 2.3 |
details | String | The details about the error. | 2.3 |
elaboration | String | The reserved field. Default value: null. | 2.3 |
opaque | LinkedHashMap | The reserved field. Default value: null. | 2.3 |
cause | ErrorCode | The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null. | 2.3 |
#inventory
Name | Type | Description | Starting Version |
---|---|---|---|
uuid | String | The resource UUID. | 2.3 |
name | String | Th resource name. | 2.3 |
description | String | The detailed description of the resource. | 2.3 |
period | Integer | The threshold duration. | 2.3 |
namespace | String | The namespace. | 2.3 |
metricName | String | The metric name. | 2.3 |
threshold | Double | The threshold. | 2.3 |
repeatInterval | Integer | The alarm repeat interval. | 2.3 |
createDate | Timestamp | The creation date. | 2.3 |
lastOpDate | Timestamp | The last operation date. | 2.3 |
comparisonOperator | ComparisonOperator | See comparisonOperator. | 2.3 |
status | AlarmStatus | See status. | 2.3 |
labels | List | See labels. | 2.3 |
actions | List | See actions. | 2.3 |
#comparisonOperator
Name | Type | Description | Starting Version |
---|---|---|---|
name | String | The resource name. | 2.3 |
ordinal | int | 2.3 |
#status
Name | Type | Description | Starting Version |
---|---|---|---|
OK | AlarmStatus | The alarm is in normal status. | 2.3 |
Alarm | AlarmStatus | The alarm is triggered. | 2.3 |
InsufficientData | AlarmStatus | The data is insufficient. | 2.3 |
#labels
Name | Type | Description | Starting Version |
---|---|---|---|
uuid | String | The resource UUID. | 2.3 |
key | String | The label key. | 2.3 |
operator | String | The comparison operator. | 2.3 |
value | String | The label value. | 2.3 |
#actions
Name | Type | Description | Starting Version |
---|---|---|---|
alarmUuid | String | The alarm UUID. | 2.3 |
actionType | String | The action type. | 2.3 |
actionUuid | String | The action UUID. | 2.3 |
SDK Sample
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()