1. 接口描述
接口请求域名： wedata.tencentcloudapi.com 。
修改任务告警规则
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ModifyTaskAlarmRegular。 |
| Version | 是 | String | 公共参数，本接口取值：2021-08-20。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Id | 是 | String | 规则ID 示例值：8756 |
| TaskAlarmInfo | 是 | TaskAlarmInfo | 规则信息 |
| ProjectId | 是 | String | 项目ID 示例值：1486446569620893696 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | Boolean | 判断是否修改成功 注意：此字段可能返回 null，表示取不到有效值。 示例值：true |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 修改任务告警规则
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyTaskAlarmRegular
<公共请求参数>
{
"Id": "1769",
"TaskAlarmInfo": {
"Id": "1289287",
"TaskId": "3cd6b1b3-76a0-4147-8f0e-6df206bc58c0",
"RegularId": "1769",
"RegularName": "测试规则",
"RegularStatus": 1,
"AlarmLevel": 1,
"AlarmIndicator": 1,
"TriggerType": 1,
"EstimatedTime": 1,
"AlarmWay": "1",
"AlarmRecipientId": "100028448903",
"TaskType": 201,
"ProjectId": "1486446569620893696",
"Creater": "100028448903",
"AlarmRecipientName": "100028448903",
"AlarmIndicatorDesc": "任务失败",
"Operator": 1,
"NodeId": "12846",
"NodeName": "node test name",
"AlarmIndicatorInfos": [
{
"Id": "",
"AlarmIndicator": 1,
"AlarmIndicatorDesc": "任务失败",
"TriggerType": 1,
"EstimatedTime": 20,
"Operator": 1,
"AlarmIndicatorUnit": "ms",
"Duration": 0,
"DurationUnit": "minute",
"MaxTimes": 0,
"Threshold": 0
}
],
"AlarmRecipientType": 1,
"QuietPeriods": [
{
"DaysOfWeek": [
6,
7
],
"EndTime": "06:00:00",
"StartTime": "00:00:01"
}
],
"WeComHook": "https://www.feishu.cn/",
"UpdateTime": "2022-04-10 10:49:56",
"OperatorUin": "100028448903",
"TaskCount": 1,
"MonitorType": 2,
"MonitorObjectIds": [
"k753e8924-a3ed-4201-b5d3-35ce683b589c"
],
"LatestAlarmInstanceId": "3047",
"LatestAlarmTime": "2022-04-11 10:49:56",
"Description": "描述",
"LarkWebHooks": "https://www.feishu.cn/"
},
"ProjectId": "1486446569620893696"
}输出示例
{
"Response": {
"Data": true,
"RequestId": "a502d7c7-d872-408e-9c2"
}
}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 | 参数错误。 |
| MissingParameter | 缺少参数错误。 |
| ResourceUnavailable | 资源不可用。 |
| UnauthorizedOperation | 未授权操作。 |