文档

GetAlarmStatus - 获取告警状态详情

更新时间:

获取告警状态详情,包含告警状态、时间、结果等内容。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

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

设备ID。

device-jrjb476ub06
MonitorItemIdstring

监控项ID。

m-22ut5sn54o35wsz6
Typestring

监控类型。

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

聚合数据ID。

a-52gmqniln3u53n32
DedicatedLineIdstring

专线ID。

d-52gmqniln3u53n32
InstanceIdstring

实例ID。

cmn-cn-xxxx
PortCollectionIdstring

端口集ID。

p-52gmqniln3u53n32
AppIdstring

应用ID。

app-52gmqniln3u53n32

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求ID。

AC8F05E6-AFBB-4AAE-B75E-A6539A9BAAA8
AlarmStatusobject

告警状态。

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

告警状态。

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
Ipstring

IP。

127.0.0.1
Vendorstring

厂商。

H3C
Modelstring

型号。

H3C-7500
Statusstring

状态。

online
Snstring

序列号。

123456
Spacestring

物理空间。

XX门店
DeviceIdstring

设备ID。

device-jrjb476ub06
SecurityDomainstring

安全域。

YT
DeviceFormstring

设备形态。

网络设备
MonitorItemobject

监控项对象。

MonitorItemNamestring

监控项名称。

Ping_Monitor
MonitorItemDescriptionstring

监控项描述。

连通性监控
SecurityDomainstring

安全域。

YT
CollectionTypestring

采集类型。

PING
ExecIntervalstring

执行间隔。

60
MonitorItemIdstring

监控项ID。

m-22ut5sn54o35wsz6
DeviceFormstring

设备形态。

网络设备
Effectivelong

是否启用。

1
FirstAbnormalTimestring

首次异常时间。

2021-01-01 00:01:00
NotificationSwitchobject

告警开关。

Reasonstring

关闭原因。

Temporarily Closed
ExpiryTimestring

关闭到期时间。

2021-01-01 00:01:00
AggregateDataIdstring

聚合数据ID。

a-52gmqniln3u53n32
DedicatedLineIdstring

专线ID。

d-52gmqniln3u53n32
AggregateDataobject

聚合数据对象。

AggregateModestring

聚合方式。

SUM
AggregateDataDescriptionstring

聚合数据描述。

avg latency avg
DataItemstring

数据项。

latency
AggregateDataNamestring

聚合数据名称。

avg_latency_avg
DeviceIdstring

设备ID。

device-jrjb476ub06
IsAllDeviceinteger

是否聚合全部设备。

0
AggregateDataIdstring

聚合数据ID。

a-52gmqniln3u53n32
MonitorItemIdstring

监控项ID。

m-22ut5sn54o35wsz6
DedicatedLineobject

专线详情。

DedicatedLineNamestring

专线名称。

XX林店_专线
Spacestring

物理空间。

XX门店
PortNamestring

端口名。

GigabitEthernet1/0/0
DeviceIdstring

设备ID。

device-jrjb476ub06
Bandwidthstring

带宽。

100
Ipstring

IP。

127.0.0.1
DedicatedLineGatewaystring

专线网关IP。

127.0.0.1
PortCollectionIdstring

端口集ID。

p-fwq29cmatva28
PortCollectionobject

端口集。

PortCollectionNamestring

端口集名称。

端口集
PortCollectionIdstring

端口集ID。

p-l3oo18oaz1n1cnfp
PortCollectionDescriptionstring

端口集描述。

端口集描述
PortListobject []

端口列表。

PortNamestring

端口名。

端口名
DeviceIdstring

设备ID。

device-9jv4joxowp43whjx
ResourceDeviceobject

设备详情。

HostNamestring

设备名。

设备名
Ipstring

IP。

127.0.0.1
SecurityDomainstring

安全域。

HZ
AgentIpstring

采集探针IP。

127.0.0.1
AppIdstring

应用ID。

app-52gmqniln3u53n32
ResourceAppobject

应用。

Domainstring

监控域名。

www.example.com
AppIdstring

应用ID。

app-0ijhb6yujk
Portstring

端口。

3306
Typestring

资源类型。

SINGLE
SecurityDomainstring

所属探针。

TEST002

示例

正常返回示例

JSON格式

{
  "RequestId": "AC8F05E6-AFBB-4AAE-B75E-A6539A9BAAA8",
  "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",
      "Ip": "127.0.0.1",
      "Vendor": "H3C",
      "Model": "H3C-7500",
      "Status": "online",
      "Sn": "123456",
      "Space": "XX门店",
      "DeviceId": "device-jrjb476ub06",
      "SecurityDomain": "YT",
      "DeviceForm": "网络设备"
    },
    "MonitorItem": {
      "MonitorItemName": "Ping_Monitor",
      "MonitorItemDescription": "连通性监控",
      "SecurityDomain": "YT",
      "CollectionType": "PING",
      "ExecInterval": "60",
      "MonitorItemId": "m-22ut5sn54o35wsz6",
      "DeviceForm": "网络设备",
      "Effective": 1
    },
    "FirstAbnormalTime": "2021-01-01 00:01:00",
    "NotificationSwitch": {
      "Reason": "Temporarily Closed",
      "ExpiryTime": "2021-01-01 00:01:00"
    },
    "AggregateDataId": "a-52gmqniln3u53n32",
    "DedicatedLineId": "d-52gmqniln3u53n32",
    "AggregateData": {
      "AggregateMode": "SUM",
      "AggregateDataDescription": "avg latency avg",
      "DataItem": "latency",
      "AggregateDataName": "avg_latency_avg",
      "DeviceId": "device-jrjb476ub06",
      "IsAllDevice": 0,
      "AggregateDataId": "a-52gmqniln3u53n32",
      "MonitorItemId": "m-22ut5sn54o35wsz6"
    },
    "DedicatedLine": {
      "DedicatedLineName": "XX林店_专线",
      "Space": "XX门店",
      "PortName": "GigabitEthernet1/0/0",
      "DeviceId": "device-jrjb476ub06",
      "Bandwidth": "100",
      "Ip": "127.0.0.1",
      "DedicatedLineGateway": "127.0.0.1"
    },
    "PortCollectionId": "p-fwq29cmatva28\t\n",
    "PortCollection": {
      "PortCollectionName": "端口集",
      "PortCollectionId": "p-l3oo18oaz1n1cnfp",
      "PortCollectionDescription": "端口集描述",
      "PortList": [
        {
          "PortName": "端口名",
          "DeviceId": "device-9jv4joxowp43whjx",
          "ResourceDevice": {
            "HostName": "设备名",
            "Ip": "127.0.0.1",
            "SecurityDomain": "HZ"
          }
        }
      ]
    },
    "AgentIp": "127.0.0.1",
    "AppId": "app-52gmqniln3u53n32\t\n",
    "ResourceApp": {
      "Domain": "www.example.com",
      "AppId": "app-0ijhb6yujk",
      "Port": "3306",
      "Type": "SINGLE",
      "SecurityDomain": "TEST002"
    }
  }
}

错误码

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

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

  • 本页导读 (0)
文档反馈