有奖:语音产品征文挑战赛火热进行中> HOT

1. 接口描述

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

告警列表查询

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeAlarmList。
Version String 公共参数,本接口取值:2023-04-27。
Region String 公共参数,详见产品支持的 地域列表
BeginTime Integer 告警开始时间,必填,时间戳秒
示例值:1684464518
EndTime Integer 告警结束时间,必填,时间戳秒
示例值:1684723718
PageNumber Integer 分页查询,第几页
示例值:1
PageSize Integer 每页条数
示例值:1
WorkspaceId Integer 工作空间id
示例值:1016
ApplicationToken String 应用token
示例值:xxx
Statuses.N Array of String 告警状态
示例值:processed
AlarmTypeSet.N Array of AlarmTypeInfo 告警类型
示例值:{ "Type": "test1", "SubType": "test2" }
LevelSet.N Array of Integer 告警级别id
示例值:1
IdSet.N Array of String 告警id
示例值:atest
AppIdSet.N Array of Integer 应用id
示例值:0
WIDSet.N Array of String 设备id
示例值:xxx-aaa
SpaceCodeSet.N Array of String 空间层级
示例值:10010
ExtendOne.N Array of String 应用扩展字段1
示例值:{"a":"t"}
ExtendTwo.N Array of String 应用扩展字段2
示例值:x-json:{"a":"t"}
ProcessorSet.N Array of String 当前告警处理人,填孪生中台的用户id
示例值:13
GroupIdSet.N Array of Integer 分组id
示例值:[1,2,3]

3. 输出参数

参数名称 类型 描述
Result DescribeAlarmListRes 告警列表查询结果
示例值:{"AlarmInfoSet": [{"AppId": 0,"Desc": "水量使用超限","DeviceName": "20楼水表","Echo": "","Extend": "x-json:{"alarmLevel":3,"alarmValue":13730945.6}","ExtendOne": "x-json:","ExtendTwo": "x-json:","HandlePersonSet": [],"HandleRecordSet": [],"Id": "0c6ec1cc-25d6-43bc-96b1-6b4131f1771a","Level": 3,"LevelName": "严重","Position": "滨海大厦-7F","ReportImg": {"Data": "","Type": 0},"Status": "unprocessed","SubType": "water_limit","SubTypeName": "水量使用超限","Time": 1693416976,"Type": "energy","TypeName": "能源","WID": "b1fd7aa3-4407-4b82-9dc3-aff9b3034a9f","WorkspaceId": 1016}],"PageNumber": 1,"PageSize": 1,"TotalPage": 125,"TotalRow": 125}}
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 告警列表

成功响应

输入示例

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

{
    "BeginTime": 1693416387,
    "EndTime": 1693416987,
    "PageNumber": 1,
    "PageSize": 1,
    "WorkspaceId": 1016,
    "ApplicationToken": "YVySZSL1Lp5UtSJ5uJVLJYOKDEGfCCH2"
}

输出示例

{
    "Response": {
        "RequestId": "bb4a6274-71b1-4107-98a2-06819376fb4e",
        "Result": {
            "AlarmInfoSet": [
                {
                    "AppId": 0,
                    "Desc": "水量使用超限",
                    "DeviceName": "20楼水表",
                    "Echo": "",
                    "Extend": "x-json:{\"alarmLevel\":3,\"alarmValue\":13730945.6}",
                    "ExtendOne": "x-json:",
                    "ExtendTwo": "x-json:",
                    "HandlePersonSet": [],
                    "HandleRecordSet": [],
                    "Id": "0c6ec1cc-25d6-43bc-96b1-6b4131f1771a",
                    "Level": 3,
                    "LevelName": "严重",
                    "Position": "滨海大厦-7F",
                    "ReportImg": {
                        "Data": "",
                        "Type": 0
                    },
                    "Status": "unprocessed",
                    "SubType": "water_limit",
                    "SubTypeName": "水量使用超限",
                    "Time": 1693416976,
                    "Type": "energy",
                    "TypeName": "能源",
                    "WID": "b1fd7aa3-4407-4b82-9dc3-aff9b3034a9f",
                    "WorkspaceId": 1016
                }
            ],
            "PageNumber": 1,
            "PageSize": 1,
            "TotalPage": 125,
            "TotalRow": 125
        }
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.ApiRuleConfigError Api规则配置信息错误
InvalidParameter 参数错误。
InvalidParameterValue.InvalidWorkspaceId 错误的工作空间Id
ResourceNotFound 资源不存在。
UnauthorizedOperation.UnauthorizedApi 应用api的数据授权未配置,请先配置权限