全部产品
Search

搜索本产品

    大数据开发治理平台 DataWorks：UpdateDIAlarmRule - 更新数据集成新版任务告警规则

    文档中心

    大数据开发治理平台 DataWorks：UpdateDIAlarmRule - 更新数据集成新版任务告警规则

    更新时间：Nov 21, 2024

    更新数据集成新版任务告警规则，当前支持的任务类型包括：MySQL到Hologres整库实时解决方案。

    接口说明

    当您的任务同步类型中包含实时同步时，支持设置告警规则。 告警规则更新为全字段更新，不支持部分字段更新。

    调试

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

    授权信息

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

    请求参数

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

    告警规则 ID。

    		34982
    Descriptionstring否

    描述。

    		mysql同步到hologres心跳告警
    MetricTypestring是

    告警指标类型，可选的枚举值：

    • Heartbeat（任务状态报警）
    • FailoverCount（failover 次数报警）
    • Delay（任务延迟报警）
    		Heartbeat
    TriggerConditionsarray<object>是

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

    object是

    告警触发条件。

    Severitystring否

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

    • Warning
    • Critical
    		Warning
    Durationlong否

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

    		15
    Thresholdlong否

    告警阈值。

    • 任务状态报警：无需填写阈值。
    • failover 次数报警：阈值为 failover 次数。
    • 任务延迟报警：阈值为延迟时长，单位秒。
    		5
    NotificationSettingsobject是

    告警通知设置。

    NotificationChannelsarray<object>是

    告警通知渠道，支持多值。

    object否

    告警通知渠道。

    Severitystring否

    严重程度，可选的枚举值：

    • Warning
    • Critical
    		Warning
    Channelsarray否

    通道列表。

    string否

    通道，可选的枚举值：

    • Mail（邮件）
    • Phone（电话）
    • Sms（短信）
    • Ding（钉钉）
    		Ding
    NotificationReceiversarray<object>是

    告警通知接收方，支持多值。

    object否

    告警通知接收方。

    ReceiverTypestring否

    接收方类型。

    • 当告警通知渠道为邮件、电话、短信时，接收方类型选择阿里云用户 ID。
    • 当告警通知渠道为钉钉时，接收方类型选择钉钉 token。
    		DingToken
    ReceiverValuesarray否

    接收方取值列表。

    string否

    接收方取值。

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

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

    		5
    Enabledboolean否

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

    		true

    返回参数

    名称类型描述示例值
    object

    响应。

    RequestIdstring

    请求 ID。

    		A6C6B486-E3A2-5D52-9E76-D9380485D946

    示例

    正常返回示例

    JSON格式

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

    错误码

    HTTP status code错误码错误信息描述
    403Forbidden.AccessAccess is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.没有权限，请授权
    429Throttling.ApiThe request for this resource has exceeded your available limit.对该资源的请求已超过您的可用上限。
    429Throttling.SystemThe DataWorks system is busy. Try again later.DataWorks系统繁忙，请稍后再试。
    429Throttling.UserYour request is too frequent. Try again later.您的请求过于频繁，请尝试放缓请求速度。
    500InternalError.SystemAn internal system error occurred. Try again later.系统内部错误，请稍后再试。
    500InternalError.UserId.MissingAn internal system error occurred. Try again later.系统内部错误，请稍后再试。

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

    变更历史

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