CreateAlarm

POST/zstack/v1/zwatch/alarms

Operation ID

CreateAlarm

Since

2.3

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

application/json

Body Fields

params
ObjectRequired
Request body parameter object.
- name
  StringRequired
  The resource name.
- description
  String
  Optional. The detailed description of the resource.
- comparisonOperator
  StringRequired
  The threshold comparison operator.
- period
  Integer
  The threshold duration.
- namespace
  StringRequired
  The namespace.
- metricName
  StringRequired
  The metric name.
- threshold
  DoubleRequired
  The threshold.
- repeatInterval
  Integer
  Optional. The alarm repeat interval.
- labels
  List
  Optional. The label list.
- actions
  List
  Optional. The alarm action list.
- resourceUuid
  String
  Optional.
- repeatCount
  Integer
  Optional. The alarm repeat count.
- type
  String
  Optional. The alarm type.
- enableRecovery
  BooleanRequired
  Whether to enable the recovery notification.
- emergencyLevel
  String
  Optional. The alarm emergency level.
systemTags
List
Optional. The system tags.
userTags
List
Optional. The user tags.

Responses

200 OK

On success, this API returns the following response structure.

error
ErrorCodeRequired
The error code. If not null, the operation fails, or vice versa. For more information, see error.
- code
  StringRequired
  The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.
- description
  StringRequired
  The brief description of the error.
- details
  StringRequired
  The details about the error.
- elaboration
  StringRequired
  The reserved field. Default value: null.
- opaque
  LinkedHashMapRequired
  The reserved field. Default value: null.
- cause
  ErrorCodeRequired
  The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.
inventory
AlarmInventoryRequired
See inventory.
- uuid
  StringRequired
  The resource UUID.
- name
  StringRequired
  Th resource name.
- description
  StringRequired
  The detailed description of the resource.
- period
  IntegerRequired
  The threshold duration.
- namespace
  StringRequired
  The namespace.
- metricName
  StringRequired
  The metric name.
- threshold
  DoubleRequired
  The threshold.
- repeatInterval
  IntegerRequired
  The alarm repeat interval.
- enableRecovery
  BooleanRequired
  Whether to enable the recovery notification.
- createDate
  TimestampRequired
  The creation date.
- lastOpDate
  TimestampRequired
  The last operation date.
- comparisonOperator
  ComparisonOperatorRequired
  See comparisonOperator.
  name
  StringRequired
  The resource name.
  ordinal
  intRequired
  The ordinal number.
- status
  AlarmStatusRequired
  See status.
  OK
  AlarmStatusRequired
  The alarm is in normal status.
  Alarm
  AlarmStatusRequired
  The alarm is triggered.
  InsufficientData
  AlarmStatusRequired
  The data is insufficient.
- labels
  ListRequired
  See labels.
  uuid
  StringRequired
  The resource UUID.
  key
  StringRequired
  The label key.
  operator
  StringRequired
  The comparison operator.
  value
  StringRequired
  The label value.
- actions
  ListRequired
  See actions.
  alarmUuid
  StringRequired
  The alarm UUID.
  actionType
  StringRequired
  The action type.
  actionUuid
  StringRequired
  The action UUID.

Request Example

curl -X POST '{host}/zstack/v1/zwatch/alarms' \
  -H 'Authorization: Bearer {token}' \
  -H 'Content-Type: application/json' \
  -d '{
  "params": {
    "name": "{name}",
    "description": "{description}",
    "comparisonOperator": "{comparisonOperator}",
    "period": "{period}",
    "namespace": "{namespace}",
    "metricName": "{metricName}",
    "threshold": "{threshold}",
    "repeatInterval": "{repeatInterval}",
    "labels": [
      "{labels}"
    ],
    "actions": [
      "{actions}"
    ],
    "resourceUuid": "{resourceUuid}",
    "repeatCount": "{repeatCount}",
    "type": "{type}",
    "enableRecovery": "{enableRecovery}",
    "emergencyLevel": "{emergencyLevel}"
  },
  "systemTags": [
    "{systemTags}"
  ],
  "userTags": [
    "{userTags}"
  ]
}'

Response Example

{
  "inventory": {
    "uuid": "6ff094db7e8b4640880751c5a17e7b63",
    "name": "VM CPU Alarm",
    "comparisonOperator": "LessThanOrEqualTo",
    "period": 60,
    "namespace": "ZStack/VM",
    "metricName": "org.zstack.zwatch.datatype.Metric@c2e79f0",
    "threshold": 30,
    "repeatInterval": 1800,
    "repeatCount": -1,
    "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": "=",
        "value": "f486fd81583747459d8a6cd47f9228e5"
      }
    ],
    "actions": [
      {
        "alarmUuid": "8a6a98e3cc484388a746d725265886b3",
        "actionType": "sns",
        "actionUuid": "86a2b51fbc7f406c906711081852fa49"
      }
    ]
  }
}

VM Instance Operations

Volume Operations

Image Operations

Affinity Group Operations

VM Scheduling Rule Group Operations

Instance Offering Operations

Disk Offering Operations

Auto-Scaling Group Operations

Snapshot Group Operations

SSH Key Operations

Zone Operations

Cluster Operations

Host Operations

GPU Device Operations

Primary Storage Operations

Backup Storage Operations

SAN Storage Operations

Physical Network Operations

PCI Device Operations

USB Redirection Operations

USB Pass-through Operations

SR-IOV Operations

Loongarch SE Operations

Hygon SE Operations

Local Storage Operations

NFS Primary Storage Operations

Shared Mount Point Primary Storage Operations

Ceph Primary Storage Operations

Shared Block Primary Storage Operations

XStor Block Primary Storage Operations

ImageStore Backup Storage Operations

Ceph Backup Storage Operations

iSCSI Server Operations

FC Storage Operations

NVMe Storage Operations

Hardware SDN Controller Operations

L2 Network Operations

L3 Network Operations

Route Resource Operations

VPC Operations

OSPF Operations

Multicast Routing Operations

Policy Routing Operations

vRouter Route Table Operations

Network Service Operations

VPC Firewall Operations

Security Group Operations

VIP Operations

EIP Operations

Port Forwarding Operations

Load Balancing Operations

IPsec Operations

NetFlow APIs

Port Mirroring APIs

Shared Bandwidth Operations

Network Security Policy Schedule Operations

CloudFormation Operations

Bare Metal Management Operations

Installation Service Operations

Elastic Bare Metal Management(Plus)

vCenter Operations

Capacity Management Operations

SNS Operations

Metric Operations

Event Operations

Alarm Operations

Event Subscription Operations

Text Template Operations

Audit Operations

CBT Operations

Backup Service Operations

CDP Operations

Script Library

XML Hook

Job Scheduling APIs

Tag Operations

Migration Service Operations

Organization Operations

Project Operations

Ticket Operations