获取告警列表

最近更新时间:2024-03-12 01:35:36

我的收藏

1. 接口描述

接口请求域名: iotvideoindustry.tencentcloudapi.com 。

获取告警列表

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeWarnings。
Version String 公共参数,本接口取值:2020-12-01。
Region String 公共参数,详见产品支持的 地域列表
OrderType Integer 1:创建时间倒序 2:创建时间升序 3:level倒序 4:leve升序
示例值:1
DeviceId String 可选设备id
示例值:99576636581320000310_99782261871320000002
WarnLevelArray.N Array of Integer 如果不传则查询所有,取值参见配置
示例值:[1]
WarnModeArray.N Array of Integer 如果不传则查询所有,取值参见配置
示例值:[0]
Offset Integer 不传认为是0
示例值:0
Limit Integer 不传认为是20
示例值:20
DateBegin String 形似:2021-05-21 00:00:00 .取值在当前日前30天内,不传默认是当前日前30天日期
示例值:2021-05-21 00:00:00
DateEnd String 形似:2021-05-21 23:59:59 .取值在当前日前30天内,不传默认是当前日前30天日期
示例值:2021-05-21 00:00:00

3. 输出参数

参数名称 类型 描述
Total Integer 总数
注意:此字段可能返回 null,表示取不到有效值。
示例值:100
Data Array of WarningsData 告警列表
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取告警列表

输入示例

POST / HTTP/1.1
Host: iotvideoindustry.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeWarnings
<公共请求参数>

{
    "WarnLevelArray": [
        1
    ],
    "WarnModeArray": [
        2
    ],
    "OrderType": 1
}

输出示例

{
    "Response": {
        "Data": [
            {
                "Id": 2,
                "DeviceId": "34020000001320000000_34020000001320000000",
                "DeviceName": "test2",
                "WarnChannel": "34020000001320000000_34020000001320000000",
                "WarnLevel": 1,
                "WarnLevelName": "一级警情",
                "WarnMode": 2,
                "WarnModeName": "设备报警",
                "WarnType": 5,
                "Del": 0,
                "CreateTime": "2021-05-25T17:56:51+08:00",
                "UpdateTime": "2021-05-25T17:56:51+08:00"
            },
            {
                "Id": 1,
                "DeviceId": "34020000001320000000_34020000001320000000",
                "DeviceName": "test2",
                "WarnChannel": "34020000001320000000_34020000001320000000",
                "WarnLevel": 1,
                "WarnLevelName": "一级警情",
                "WarnMode": 2,
                "WarnModeName": "设备报警",
                "WarnType": 5,
                "Del": 0,
                "CreateTime": "2021-05-25T16:23:59+08:00",
                "UpdateTime": "2021-05-25T16:23:59+08:00"
            }
        ],
        "RequestId": "226618be-27ec-46f4-a19e-bdb980baec92",
        "Total": 2
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码