获取告警状态详情，包含告警状态、时间、结果等内容。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| cmn:GetAlarmStatus | get |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DeviceId | string | 否 | 设备 ID。 | device-jrjb476ub06 |
| MonitorItemId | string | 否 | 监控项 ID。 | m-22ut5sn54o35wsz6 |
| Type | string | 是 | 监控类型。
| SINGLE |
| AggregateDataId | string | 否 | 聚合数据 ID。 | a-52gmqniln3u53n32 |
| DedicatedLineId | string | 否 | 专线 ID。 | d-52gmqniln3u53n32 |
| InstanceId | string | 是 | 实例 ID。 | cmn-cn-xxxx |
| PortCollectionId | string | 否 | 端口集 ID。 | p-52gmqniln3u53n32 |
| AppId | string | 否 | 应用 ID。 | app-52gmqniln3u53n32 |
返回参数
示例
正常返回示例
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 | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | InvalidParameter%s | The specified parameter %s is invalid. | 参数无效，请检查参数 |
| 400 | Missing%s | You must specify the parameter %s. | 必填参数没有填。请检查调用时是否填写了此参数，并重试请求。 |
| 400 | SignatureDoesNotMatch | 签名不通过 | - |
| 403 | NoPermission | 没有权限 | - |
| 404 | Invalid%s.NotFound | The specified resource %s does not exist. | 找不到对应资源 |
| 404 | ServiceNotFound | 后端服务未找到 | - |
| 500 | InternalError | 服务器内部错误 | - |
| 503 | ServiceUnavailable | 服务不可用 | - |
访问错误中心查看更多错误码。