文档

ListAlarmStatus - 获取监控状态列表

更新时间:

获取监控状态列表,包括单设备监控状态、专线监控状态及聚合数据监控状态。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
cmn:ListAlarmStatuslist
  • MonitorItem
    acs:cmn:{#regionId}:{#accountId}:monitoritem/*

请求参数

名称类型必填描述示例值
NextTokenstring

标记当前开始读取的位置,置空表示从头开始。

10
MaxResultsinteger

本次读取的最大数据记录数量。

10
Spacestring

物理空间。

XX门店
DeviceFormstring

设备形态。

网络设备
Statusstring

告警状态。

  • NORMAL:正常。
  • WARNING:警告。
  • CRITICAL:严重。
  • WAITING:等待。
  • ERROR:错误。
WARNING
DeviceIdstring

设备 ID。

device-jrjb476ub06
MonitorItemIdstring

监控项 ID。

m-22ut5sn54o35wsz6
Typestring

数据类型。

  • SINGLE:单设备。
  • APP:应用。
  • AGGREGATE:聚合监控。
  • PORT_COLLECTION:端口集。
  • DEDICATED_LINE:专线。
  • EVENT:事件。
  • CUSTOM:自定义。
SINGLE
InstanceIdstring

实例 ID。

cmn-cn-13edefd2
DedicatedLineNamestring

专线名称。

专线名称
Regionstring

地域。

Northeast China
PhysicalSpaceIdstring

物理空间 ID。

space-123wefv243
SpaceTypestring

物理空间类型。

园区
Manufacturerstring

厂商。

H3C
Modelstring

型号。

5800
SecurityDomainstring

探针标识。

CMN-A01
Countrystring

国家。

中国
Provincestring

省份。

浙江省
Citystring

城市。

杭州市
Rolestring

设备角色。

ASW
ServiceStatusstring

设备状态。

online
PortCollectionIdstring

端口集 ID。

p-08uhbnlo9ygbn
UniqueKeystring

唯一索引。

a-iuhb098uyhbvgh
HostNamestring

设备名称。

asw-1
PortCollectionNamestring

端口集名称。

端口集名称
AggregateDataNamestring

聚合数据名称。

聚合数据名称
Domainstring

拨测域名。

www.example.com
DedicatedLineIdstring

专线 ID。

space-isp_knbghjkl09u

返回参数

名称类型描述示例值
object

Schema of Response

TotalCountinteger

TotalCount 本次请求条件下的数据总量,此参数为可选参数,默认可不返回。

100
RequestIdstring

请求 ID。

AC8F05E6-AFBB-4AAE-B75E-A6539A9BAAA8
NextTokenstring

表示当前调用返回读取到的位置,空代表数据已经读取完毕。

10
MaxResultsinteger

MaxResults 本次请求所返回的最大记录条数。

10
AlarmStatusarray<object>

告警状态列表。

object

告警状态。

DeviceIdstring

设备 ID。

device-jrjb476ub06
MonitorItemIdstring

监控项 ID。

m-22ut5sn54o35wsz6
CollectionTimestring

检测时间。

2021-01-01 00:01:00
ReceiveTimestring

接收时间。

2021-01-01 00:01:00
AlarmRulestring

命中告警规则。

{"alarmStatus":"WARNING","expression":">=","variable":"avg-latency","monitorItemId":"m-52gmqniln3u53n32","type":"SINGLE","value":"0"}
AlarmStatusstring

告警状态。

  • NORMAL:正常。
  • WARNING:警告。
  • CRITICAL:严重。
  • WAITING:等待。
  • ERROR:错误。
WARNING
Resultstring

采集结果。

{"loss_rate":"0","avg-latency":"4.51"}
AbnormalDataItemstring

异常数据项。

[{"avg_latency":4.51}]
UniqueKeystring

唯一索引。

d-fwq29cmatva28_m-52gmqniln3u53n32
ResponseCodestring

采集状态码

OK
ResourceDeviceobject

设备对象。

HostNamestring

设备名。

CSW-HZ3.YT
PhysicalSpacestring

物理空间名称。

XX门店
DeviceFormstring

设备形态。

网络设备
Citystring

城市。

杭州
MonitorItemobject

监控项对象。

MonitorItemNamestring

监控项名称。

Ping_Monitor
CollectionTypestring

采集类型。

SNMP
MonitorItemDescriptionstring

监控项描述。

ping monitor
FirstAbnormalTimestring

首次异常时间。

2021-01-01 00:01:00
NotificationSwitchobject

告警开关配置对象。

Reasonstring

关闭原因。

Temporarily Closed
ExpiryTimestring

关闭到期时间。

2021-01-01 00:01:00
AggregateDataIdstring

聚合数据 ID。

a-52gmqniln3u53n32
AggregateDataobject

聚合数据对象。

AggregateDataNamestring

聚合数据名称。

avg_latency_avg
DataItemstring

数据项。

avg_latency
DedicatedLineIdstring

专线 ID。

d-52gmqniln3u53n32
DedicatedLineobject

专线对象。

DedicatedLineNamestring

专线名称。

XX门店_专线
PhysicalSpacestring

物理空间名称。

XX门店
PortCollectionIdstring

端口集 ID。

p-09iuhbv456yj
PortCollectionobject

端口集对象。

PortCollectionNamestring

端口集名称。

端口集名称
AgentIpstring

采集探针 IP。

127.0.0.1
AppIdstring

应用 ID。

app-0ijhb6yujk
ResourceAppobject

应用资源对象。

Domainstring

监控域名。

www.example.com
AppIdstring

应用 ID。

app-0ijhb6yujk
Portstring

端口。

3306
Typestring

资源类型。

HTTP
SecurityDomainstring

所属探针。

CMN-A01
Statisticsarray<object>

告警状态统计列表。

object

告警状态统计对象。

Countlong

告警数量。

10
Statusstring

告警状态。

WARNING

示例

正常返回示例

JSON格式

{
  "TotalCount": 100,
  "RequestId": "AC8F05E6-AFBB-4AAE-B75E-A6539A9BAAA8",
  "NextToken": "10",
  "MaxResults": 10,
  "AlarmStatus": [
    {
      "DeviceId": "device-jrjb476ub06",
      "MonitorItemId": "m-22ut5sn54o35wsz6",
      "CollectionTime": "2021-01-01 00:01:00",
      "ReceiveTime": "2021-01-01 00:01:00",
      "AlarmRule": "{\"alarmStatus\":\"WARNING\",\"expression\":\">=\",\"variable\":\"avg-latency\",\"monitorItemId\":\"m-52gmqniln3u53n32\",\"type\":\"SINGLE\",\"value\":\"0\"}",
      "AlarmStatus": "WARNING",
      "Result": "{\"loss_rate\":\"0\",\"avg-latency\":\"4.51\"}",
      "AbnormalDataItem": "[{\"avg_latency\":4.51}]",
      "UniqueKey": "d-fwq29cmatva28_m-52gmqniln3u53n32",
      "ResponseCode": "OK",
      "ResourceDevice": {
        "HostName": "CSW-HZ3.YT",
        "PhysicalSpace": "XX门店",
        "DeviceForm": "网络设备",
        "City": "杭州"
      },
      "MonitorItem": {
        "MonitorItemName": "Ping_Monitor",
        "CollectionType": "SNMP",
        "MonitorItemDescription": "ping monitor"
      },
      "FirstAbnormalTime": "2021-01-01 00:01:00",
      "NotificationSwitch": {
        "Reason": "Temporarily Closed",
        "ExpiryTime": "2021-01-01 00:01:00"
      },
      "AggregateDataId": "a-52gmqniln3u53n32",
      "AggregateData": {
        "AggregateDataName": "avg_latency_avg",
        "DataItem": "avg_latency"
      },
      "DedicatedLineId": "d-52gmqniln3u53n32",
      "DedicatedLine": {
        "DedicatedLineName": "XX门店_专线",
        "PhysicalSpace": "XX门店"
      },
      "PortCollectionId": "p-09iuhbv456yj",
      "PortCollection": {
        "PortCollectionName": "端口集名称"
      },
      "AgentIp": "127.0.0.1",
      "AppId": "app-0ijhb6yujk",
      "ResourceApp": {
        "Domain": "www.example.com",
        "AppId": "app-0ijhb6yujk",
        "Port": "3306",
        "Type": "HTTP",
        "SecurityDomain": "CMN-A01"
      }
    }
  ],
  "Statistics": [
    {
      "Count": 10,
      "Status": "WARNING"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400Missing%sYou must specify the parameter %s.必填参数没有填。请检查调用时是否填写了此参数,并重试请求。
400InvalidParameter%sThe specified parameter %s is invalid.参数无效,请检查参数
400SignatureDoesNotMatch签名不通过-
403NoPermission没有权限-
404ServiceNotFound后端服务未找到-
500InternalError服务器内部错误-
503ServiceUnavailable服务不可用-

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史