Skip to main content
ZStack
Platform O&M/Cloud Monitoring/Monitoring and Alarm/SNS/ZWatch Operations/Alarm Operations

QueryAlarm

QueryAlarm

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

Operation ID

QueryAlarm

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

Query Parameters

  • q
    String

    Query conditions.

Responses

200 OK
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.

  • inventories
    ListRequired

    See inventories.

    • 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.

    • 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.