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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
NextToken String 10

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

MaxResults Integer 10

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

Space String 银泰武林店

物理空间

DeviceForm String 网络设备

设备形态

Status String WARNING

告警状态

DeviceId String device-jrjb476ub06

设备ID

MonitorItemId String m-22ut5sn54o35wsz6

监控项ID

Type String SINGLE

数据类型

返回数据

名称 类型 示例值 描述
TotalCount Integer 100

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

RequestId String AC8F05E6-AFBB-4AAE-B75E-A6539A9BAAA8

Id of the request

NextToken String 10

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

MaxResults Integer 10

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

AlarmStatus Array of content

告警状态列表

DeviceId String device-jrjb476ub06

设备ID

MonitorItemId String m-22ut5sn54o35wsz6

监控项ID

CollectionTime String 2021-01-01 00:01:00

检测时间

ReceiveTime String 2021-01-01 00:01:00

接收时间

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

命中告警规则

AlarmStatus String WARNING

告警状态

Result String {"loss_rate":"0","avg-latency":"4.51"}

采集结果

AbnormalDataItem String [{"avg_latency":4.51}]

异常数据项

UniqueKey String d-fwq29cmatva28_m-52gmqniln3u53n32

索引

ResponseCode String OK

采集状态码

ResourceDevice object

设备

HostName String CSW-HZ3.YT

设备名

MonitorItem object

监控项

MonitorItemName String Ping_Monitor

监控项名称

FirstAbnormalTime String 2021-01-01 00:01:00

首次异常时间

NotificationSwitch object

告警开关配置

Reason String Temporarily Closed

关闭原因

ExpiryTime String 2021-01-01 00:01:00

关闭到期时间

AggregateDataId String a-52gmqniln3u53n32

聚合数据ID

AggregateData object

聚合数据

AggregateDataName String avg_latency_avg

聚合数据名称

DataItem String avg_latency

数据项

DedicatedLineId String d-52gmqniln3u53n32

专线ID

DedicatedLine object

专线

DedicatedLineName String 银泰武林店_电信

专线名称

示例

请求示例

http(s)://[Endpoint]/?Space=银泰武林店
&Status=WARNING
&DeviceForm=网络设备
&Type=SINGLE
&NextToken=10
&DeviceId=device-jrjb476ub06
&MaxResults=10
&MonitorItemId=m-22ut5sn54o35wsz6
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<TotalCount>100</TotalCount>
<RequestId>AC8F05E6-AFBB-4AAE-B75E-A6539A9BAAA8</RequestId>
<NextToken>10</NextToken>
<MaxResults>10</MaxResults>
<AlarmStatus>
    <ResponseCode>OK</ResponseCode>
    <CollectionTime>2021-01-01 00:01:00</CollectionTime>
    <AggregateData>
        <AggregateDataName>avg_latency_avg</AggregateDataName>
        <DataItem>avg_latency</DataItem>
    </AggregateData>
    <DeviceId>device-jrjb476ub06</DeviceId>
    <AlarmRule>{"alarmStatus":"WARNING","expression":"&gt;=","variable":"avg-latency","monitorItemId":"m-52gmqniln3u53n32","type":"SINGLE","value":"0"}</AlarmRule>
    <MonitorItem>
        <MonitorItemName>Ping_Monitor</MonitorItemName>
    </MonitorItem>
    <MonitorItemId>m-22ut5sn54o35wsz6</MonitorItemId>
    <AggregateDataId>a-52gmqniln3u53n32</AggregateDataId>
    <AbnormalDataItem>[{"avg_latency":4.51}]</AbnormalDataItem>
    <FirstAbnormalTime>2021-01-01 00:01:00</FirstAbnormalTime>
    <NotificationSwitch>
        <ExpiryTime>2021-01-01 00:01:00</ExpiryTime>
        <Reason>Temporarily Closed</Reason>
    </NotificationSwitch>
    <Result>{"loss_rate":"0","avg-latency":"4.51"}</Result>
    <DedicatedLine>
        <DedicatedLineName>银泰武林店_电信</DedicatedLineName>
    </DedicatedLine>
    <ResourceDevice>
        <HostName>CSW-HZ3.YT</HostName>
    </ResourceDevice>
    <DedicatedLineId>d-52gmqniln3u53n32</DedicatedLineId>
    <UniqueKey>d-fwq29cmatva28_m-52gmqniln3u53n32</UniqueKey>
    <AlarmStatus>WARNING</AlarmStatus>
    <ReceiveTime>2021-01-01 00:01:00</ReceiveTime>
</AlarmStatus>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalCount" : "100",
  "RequestId" : "AC8F05E6-AFBB-4AAE-B75E-A6539A9BAAA8",
  "NextToken" : "10",
  "MaxResults" : "10",
  "AlarmStatus" : [ {
    "ResponseCode" : "OK",
    "CollectionTime" : "2021-01-01 00:01:00",
    "AggregateData" : {
      "AggregateDataName" : "avg_latency_avg",
      "DataItem" : "avg_latency"
    },
    "DeviceId" : "device-jrjb476ub06",
    "AlarmRule" : "{\"alarmStatus\":\"WARNING\",\"expression\":\">=\",\"variable\":\"avg-latency\",\"monitorItemId\":\"m-52gmqniln3u53n32\",\"type\":\"SINGLE\",\"value\":\"0\"}",
    "MonitorItem" : {
      "MonitorItemName" : "Ping_Monitor"
    },
    "MonitorItemId" : "m-22ut5sn54o35wsz6",
    "AggregateDataId" : "a-52gmqniln3u53n32",
    "AbnormalDataItem" : "[{\"avg_latency\":4.51}]",
    "FirstAbnormalTime" : "2021-01-01 00:01:00",
    "NotificationSwitch" : {
      "ExpiryTime" : "2021-01-01 00:01:00",
      "Reason" : "Temporarily Closed"
    },
    "Result" : "{\"loss_rate\":\"0\",\"avg-latency\":\"4.51\"}",
    "DedicatedLine" : {
      "DedicatedLineName" : "银泰武林店_电信"
    },
    "ResourceDevice" : {
      "HostName" : "CSW-HZ3.YT"
    },
    "DedicatedLineId" : "d-52gmqniln3u53n32",
    "UniqueKey" : "d-fwq29cmatva28_m-52gmqniln3u53n32",
    "AlarmStatus" : "WARNING",
    "ReceiveTime" : "2021-01-01 00:01:00"
  } ]
}

错误码

HttpCode 错误码 错误信息 描述
400 Missing%s You must specify the parameter %s. 必填参数没有填。请检查调用时是否填写了此参数,并重试请求。
400 InvalidParameter%s The specified parameter %s is invalid. 参数无效,请检查参数

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

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