1. 接口描述
接口请求域名： wedata.tencentcloudapi.com 。
查询任务告警规则列表
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeTaskAlarmRegulations。 |
| Version | 是 | String | 公共参数，本接口取值：2021-08-20。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| ProjectId | 是 | String | 项目ID 示例值：1486446569620893696 |
| PageNumber | 是 | Integer | 当前页 示例值：1 |
| PageSize | 是 | Integer | 每页记录数 示例值：10 |
| Filters.N | 否 | Array of Filter | 过滤条件(name有RegularStatus、AlarmLevel、AlarmIndicator、RegularName) |
| OrderFields.N | 否 | Array of OrderField | 排序条件(RegularId) |
| TaskId | 否 | String | 任务ID 示例值：j224b9321-3be0-45de-ad6a-8fed924036a4 |
| TaskType | 否 | Integer | 任务类型(201代表实时任务，202代表离线任务) 示例值：201 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TaskAlarmInfos | Array of TaskAlarmInfo | 告警规则信息 注意：此字段可能返回 null，表示取不到有效值。 |
| TotalCount | Integer | 总记录数 注意：此字段可能返回 null，表示取不到有效值。 示例值：10 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询任务告警规则列表
查询告警规则列表
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTaskAlarmRegulations
<公共请求参数>
{
"Filters": [
{
"Values": [
"TaskId"
],
"Name": "j224b9321-3be0-45de-ad6a-8fed924036a4"
}
],
"PageSize": 10,
"ProjectId": "123",
"OrderFields": [
{
"Direction": "DESC",
"Name": "CreateTime"
}
],
"PageNumber": 1,
"TaskId": "j224b9321-3be0-45de-ad6a-8fed924036a4",
"TaskType": 201
}输出示例
{
"Response": {
"TaskAlarmInfos": [
{
"Id": "",
"TaskId": "j224b9321-3be0-45de-ad6a-8fed924036a4",
"RegularId": "1768",
"RegularName": "规则名称",
"RegularStatus": 1,
"AlarmLevel": 1,
"AlarmIndicator": 1,
"TriggerType": 1,
"EstimatedTime": 1,
"AlarmWay": "7",
"AlarmRecipientId": "100035441697",
"TaskType": 201,
"ProjectId": "1486446569620893696",
"Creater": "100035441697",
"AlarmRecipientName": "username",
"AlarmIndicatorDesc": "",
"Operator": 1,
"NodeId": "",
"NodeName": "",
"AlarmIndicatorInfos": [
{
"Id": "",
"AlarmIndicator": 12,
"AlarmIndicatorDesc": "每10分钟内累计重启次数",
"TriggerType": 5,
"EstimatedTime": 1,
"Operator": 1,
"AlarmIndicatorUnit": "ms",
"Duration": 0,
"DurationUnit": "ms",
"MaxTimes": 1,
"Threshold": 0
}
],
"AlarmRecipientType": 0,
"QuietPeriods": [
{
"DaysOfWeek": [
6,
7
],
"EndTime": "06:00:00",
"StartTime": "00:00:00"
}
],
"WeComHook": "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=50d83e54-97e3-41234567890",
"UpdateTime": "2024-02-27 14:45:12",
"OperatorUin": "100035441697",
"TaskCount": 0,
"MonitorType": 0,
"MonitorObjectIds": [
"k753e8924-a3ed-4201-b5d3-35ce683b589c"
],
"Description": "",
"LatestAlarmInstanceId": "",
"LatestAlarmTime": "",
"LarkWebHooks": ""
}
],
"TotalCount": 10,
"RequestId": "ec06dfed-ce42-4a5c-b23c-14a3a2227b39"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| AuthFailure.SignatureExpire | 未登录或登录已过期。 |
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| MissingParameter | 缺少参数错误。 |
| ResourceNotFound | 资源不存在。 |
| UnauthorizedOperation | 未授权操作。 |
| UnsupportedOperation | 操作不支持。 |