获取监控状态列表，包括单设备监控状态、专线监控状态及聚合数据监控状态。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| cmn:ListAlarmStatus | LIST |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| NextToken | string | 否 | 标记当前开始读取的位置，置空表示从头开始。 | 10 |
| MaxResults | integer | 是 | 本次读取的最大数据记录数量。 | 10 |
| Space | string | 否 | 物理空间。 | XX门店 |
| DeviceForm | string | 否 | 设备形态。 | 网络设备 |
| Status | string | 否 | 告警状态。
| WARNING |
| DeviceId | string | 否 | 设备 ID。 | device-jrjb476ub06 |
| MonitorItemId | string | 否 | 监控项 ID。 | m-22ut5sn54o35wsz6 |
| Type | string | 否 | 数据类型。
| SINGLE |
| InstanceId | string | 是 | 实例 ID。 | cmn-cn-13edefd2 |
| DedicatedLineName | string | 否 | 专线名称。 | 专线名称 |
| Region | string | 否 | 地域。 | Northeast China |
| PhysicalSpaceId | string | 否 | 物理空间 ID。 | space-123wefv243 |
| SpaceType | string | 否 | 物理空间类型。 | 园区 |
| Manufacturer | string | 否 | 厂商。 | H3C |
| Model | string | 否 | 型号。 | 5800 |
| SecurityDomain | string | 否 | 探针标识。 | CMN-A01 |
| Country | string | 否 | 国家。 | 中国 |
| Province | string | 否 | 省份。 | 浙江省 |
| City | string | 否 | 城市。 | 杭州市 |
| Role | string | 否 | 设备角色。 | ASW |
| ServiceStatus | string | 否 | 设备状态。 | online |
| PortCollectionId | string | 否 | 端口集 ID。 | p-08uhbnlo9ygbn |
| UniqueKey | string | 否 | 唯一索引。 | a-iuhb098uyhbvgh |
| HostName | string | 否 | 设备名称。 | asw-1 |
| PortCollectionName | string | 否 | 端口集名称。 | 端口集名称 |
| AggregateDataName | string | 否 | 聚合数据名称。 | 聚合数据名称 |
| Domain | string | 否 | 拨测域名。 | www.example.com |
| DedicatedLineId | string | 否 | 专线 ID。 | space-isp_knbghjkl09u |
返回参数
示例
正常返回示例
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 | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | Missing%s | You must specify the parameter %s. | 必填参数没有填。请检查调用时是否填写了此参数，并重试请求。 |
| 400 | InvalidParameter%s | The specified parameter %s is invalid. | 参数无效，请检查参数 |
| 400 | SignatureDoesNotMatch | 签名不通过 | - |
| 403 | NoPermission | 没有权限 | - |
| 404 | ServiceNotFound | 后端服务未找到 | - |
| 500 | InternalError | 服务器内部错误 | - |
| 503 | ServiceUnavailable | 服务不可用 | - |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|
暂无变更历史