全部产品
Search
文档中心

大数据开发治理平台 DataWorks:UpdateDIAlarmRule - 更新告警规则

更新时间:Dec 11, 2024

更新数据集成报警规则。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
DIAlarmRuleIdlong

告警规则 ID。

34982
Descriptionstring

告警规则描述。

告警规则描述。
MetricTypestring

告警指标类型,可选的枚举值:

  • Heartbeat(任务状态报警)
  • FailoverCount(failover 次数报警)
  • Delay(任务延迟报警)
  • DdlReport: DDL 通知
  • ResourceUtilization: 资源组使用率
Heartbeat
Enabledboolean

告警规则是否启用,默认不开启。

true
TriggerConditionsarray<object>

告警触发条件列表,支持多条件。

object

告警触发条件列表,支持多条件。

Severitystring

严重程度,可选的枚举值;

  • Warning
  • Critical
Warning
Durationlong

告警计算时间区间,单位分钟。

15
Thresholdlong

告警阈值。

  • 任务状态报警:无需填写阈值。
  • failover 次数报警:阈值为 failover 次数。
  • 任务延迟报警:阈值为延迟时长,单位秒。
5
DdlReportTagsarray

在 DDL 通知的时候才生效,需要生效的 DDL 列表。

string

在 MetricType 配置为 DdlReport 时才返回需要生效的 DDL 列表,包括

  • AlterAddColumn 加列
  • AlterDropColumn 删列
  • AlterRenameColumn 修改列名
  • AlterRenameTable 修改表名
  • AlterTableModify 其他修改表
AlterAddColumn
NotificationSettingsobject

告警通知设置。

NotificationChannelsarray<object>

告警通知渠道。

object

告警通知渠道。

Severitystring

严重程度,可选的枚举值:

  • Warning
  • Critical
Warning
Channelsarray

通道,可选的枚举值:

  • Mail(邮件)
  • Phone(电话)
  • Sms(短信)
  • Ding(钉钉)
string

通道,可选的枚举值:

  • Mail(邮件)
  • Phone(电话)
  • Sms(短信)
  • Ding(钉钉)
Ding
NotificationReceiversarray<object>

告警通知接收方。

object

告警通知接收方。

ReceiverTypestring

接收方类型,取值范围:AliyunUid/DingToken/FeishuToken/WebHookUrl

DingToken
ReceiverValuesarray

接收方取值。

  • 当接收方类型为阿里云 ID 时,接收方取值为具体阿里云用户 ID。
  • 当接收方类型为钉钉 token 时,接收方取值为具体钉钉 token 值。
string

接收方取值。

  • 当接收方类型为阿里云 ID 时,接收方取值为具体阿里云用户 ID。
  • 当接收方类型为钉钉 token 时,接收方取值为具体钉钉 token 值。
token1
InhibitionIntervallong

告警抑制间隔时长,单位分钟,默认 5 分钟。

5
Namestring

告警规则的名称。

alarm_rule_name
DIJobIdlong

任务 ID。

1

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求的 ID。用于定位日志,排查问题。

A6C6B486-E3A2-5D52-9E76-D9380485D946
Successboolean

调用是否成功。取值如下:

  • true:调用成功。
  • false:调用失败,您可以根据请求 ID 定位具体问题。
true

示例

正常返回示例

JSON格式

{
  "RequestId": "A6C6B486-E3A2-5D52-9E76-D9380485D946",
  "Success": true
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史