按任务查询拨测告警列表-云拨测-文档中心-腾讯云

1. 接口描述

接口请求域名： cat.tencentcloudapi.com 。

按任务查询拨测告警列表

默认接口请求频率限制：300次/秒。

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeAlarmsByTask。
Version	是	String	公共参数，本接口取值：2018-04-09。
Region	否	String	公共参数，本接口不需要传递此参数。
TaskId	是	Integer	拨测任务Id
Offset	否	Integer	从第Offset 条开始查询。缺省值为0
Limit	否	Integer	本批次查询Limit 条记录。缺省值为20
Status	否	Integer	0 全部, 1 已恢复, 2 未恢复默认为0。其他值，视为0 查全部状态
BeginTime	否	Timestamp	格式如：2017-05-09 00:00:00 缺省为7天前0点
EndTime	否	Timestamp	格式如：2017-05-10 00:00:00 缺省为明天0点
SortBy	否	String	排序字段，可为Time, ObjName, Duration, Status, Content 之一。缺省为Time
SortType	否	String	升序或降序。可为Desc, Asc之一。缺省为Desc
ObjName	否	String	告警对象的名称

3. 输出参数

参数名称	类型	描述
AlarmInfos	Array of AlarmInfo	告警信息列表
FaultRatio	Float	故障率
FaultTimeSpec	String	故障总时长
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 按任务查询拨测告警列表示例

输入示例

https://cat.tencentcloudapi.com/?Action=DescribeAlarmsByTask
&Offset=0
&Limit=2
&BeginTime=2019-12-11 00:04:24
&EndTime=2019-12-12 00:04:24
&TaskId=260409
&<公共请求参数>

输出示例

{
  "Response": {
    "AlarmInfos": [
      {
        "ObjId": "taskId_260409",
        "FirstOccurTime": "2019-12-11 23:23:00",
        "ObjName": "贴吧云签到",
        "LastOccurTime": "2019-12-11 23:28:25",
        "Status": 3,
        "Content": "近10分钟可用率0.0%,低于或等于告警阈值10.0%,请检查您的服务是否正常",
        "MetricName": "avail_ratio_recent10",
        "TaskId": 260409,
        "MetricValue": "0.0%"
      }
    ],
    "FaultTimeSpec": "5分5秒",
    "FaultRatio": 0.3762,
    "RequestId": "62116e8d-94da-401c-9d38-145d92ce1f43"
  }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
InternalError	内部错误。
InvalidParameter	参数错误。
ResourceNotFound	资源不存在。