跳转到主要内容
API Explorer|API Explorer
平台运维/云平台监控相关接口/监控报警/通知服务/监控报警相关接口/报警器（Alarm）
GETAlarm Operations起始版本 2.3同步需要认证

获取资源报警器历史

获取资源报警器历史

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

查询参数

请求参数

查询参数

  • startTimeLong

    起始时间

  • endTimeLong

    结束时间

  • limitInteger

    返回记录条数数量

  • conditionsList

    条件列表，用于过滤结果

  • countboolean

    是否查询消息数量

响应状态

200 OK

该 API 成功时返回以下响应结构。

  • errorErrorCode必填

    错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error

    • codeString必填

      错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

      根错误，引发当前错误的源错误，若无原错误，该字段为null

  • historiesList必填

    详情参考histories

    • alarmUuidString必填

      报警器UUID

    • namespaceString必填

      名字空间名称

    • metricNameString必填

      监控项名称

    • accountUuidString必填

      账户UUID

    • resourceUuidString必填

      资源UUID

    • resourceTypeString必填

      资源类型

    • alarmStatusString必填

      报警器状态

    • alarmNameString必填

      报警器名称

    • thresholdDouble必填

      报警阈值

    • periodInteger必填

      阈值持续周期

    • labelsString必填

      标签列表

    • metricValueDouble必填

      监控项当时值

    • timelong必填

      报警纪录生成时间

请求地址

GET/zstack/v1/zwatch/alarm-histories

/zstack/v1/zwatch/alarm-histories

操作 ID

GetAlarmData

永久链接

请求示例

curl -X GET 'http://{host}/zstack/v1/zwatch/alarm-histories?startTime=1&endTime=1&limit=1&conditions=<conditions>&count=True&excludeOtherAccount=True&endpointUuid=<endpointUuid>&systemTags=<systemTags>&userTags=<userTags>' -H 'Authorization: OAuth {sessionUuid}'

响应示例

200
{ "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 } ] }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史