DocsICP FilingConsole
官方文档
首页

UpdateAlertRule

更新时间：
复制 MD 格式
产品详情
我的收藏

Updates the information about a custom alert monitoring rule.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example
Id

integer

No

The rule ID.

105412
Name

string

No

The name of the rule.

collection_name
Owner

string

No

The ID of the Alibaba Cloud account used by the owner of the rule.

193379****
Enabled

boolean

No

Specifies whether to enable the rule.

true
TriggerCondition

object

No

The alert triggering condition.

Type

string

No

The alert type. Valid values:

  • Finished: An instance is successfully run.

  • UnFinished: An instance does not finish running before a specified point in time.

  • Error: An error occurs on an instance.

  • CycleUnfinished: An instance does not finish running as expected within a specific cycle.

  • Timeout: An instance times out.

  • InstanceTransferComplete: An instance is generated by the auto triggered node.

  • InstanceTransferFluctuate: The number of generated instances fluctuates.

  • ExhaustedError: An error persists after an instance is automatically rerun.

  • InstanceKeyword: An instance with errors contains specified keywords.

  • InstanceErrorCount: The number of instances on which an error occurs reaches a specified threshold.

  • InstanceErrorPercentage: The proportion of instances on which an error occurs in the workspace to the total number of instances reaches a specified threshold.

  • ResourceGroupPercentage: The usage rate of the resource group reaches a specified threshold.

  • ResourceGroupWaitCount: The number of instances that are waiting for resources in the resource group reaches a specified threshold.

ERROR
Extension

object

No

The extended information about the rule. This parameter is required for specific types of alerts.

Error

object

No

The configuration for an alert of the Error type.

StreamTaskIds

array

No

The IDs of the real-time computing tasks. This parameter is required when you monitor real-time computing tasks.

integer

No

The ID of the real-time computing task.

123123
AutoRerunAlertEnabled

boolean

No

Specifies whether to trigger an alert if a batch synchronization task is automatically rerun upon a failure.

false
Timeout

object

No

The configuration for an alert of the Timeout type.

TimeoutInMinutes

integer

No

The timeout period. Unit: minutes.

10
UnFinished

object

No

The configuration for an alert of the UnFinished type.

UnFinishedTime

string

No

The latest completion time of the instance. The period is in the hh:mm format. Valid values of hh: [0,47]. Valid values of mm: [0,59].

12:00
CycleUnfinished

object

No

The configuration for an alert of the CycleUnfinished type.

CycleAndTime

array<object>

No

The configurations of the scheduling cycle and timeout period of the instance.

object

No

CycleId

integer

No

The ID of the scheduling cycle of the instance. Valid values: [1,288].

1
Time

string

No

The latest completion time of the instance within the scheduling cycle. The time is in the hh:mm format. Valid values of hh: [0,47]. Valid values of mm: [0,59].

01:00

InstanceErrorCount

object

No

The configuration for an alert of the InstanceErrorCount type.

Count

integer

No

The maximum number of instances on which an error occurs. Valid values: [1,10000].

10
InstanceErrorPercentage

object

No

The configuration for an alert of the InstanceErrorPercentage type.

Percentage

integer

No

The maximum percentage of instances on which an error occurs in the workspace to the total number of instances. Valid values: [1-100].

10
InstanceTransferFluctuate

object

No

The configuration for an alert of the InstanceTransferFluctuate type.

Trend

string

No

The way in which the number of auto triggered node instances that are generated in your workspace fluctuates. Valid values:

  • abs: the absolute value. The number of instances increases or decreases.

  • increase: The number of instances increases.

  • decrease: The number of instances decreases.

abs
Percentage

integer

No

The maximum percentage of fluctuation in the number of auto triggered node instances that are generated in your workspace. Valid values: [1-100].

10
Target

object

No

The monitored objects.

Type

string

No

The type of the monitored objects. Valid values:

  • Task: node

  • Baseline: baseline

  • project: workspace

  • BizProcess: workflow

Task
Ids

array

No

The IDs of monitored objects.

integer

No

The ID of the monitored object.

1894580
AllowTasks

array

No

The nodes that are not to be monitored.

integer

No

The ID of the node that is not to be monitored.

1111
Notification

object

No

The configuration for the alert notification.

SilenceStartTime

string

No

The start time for silence. The time is in the HH:mm:ss format.

00:00:00

SilenceEndTime

string

No

The end time for silence. The time is in the HH:mm:ss format.

00:00:00

IntervalInMinutes

integer

No

The interval at which an alert notification is sent. Unit: minutes. Valid values: [5,10000].

30
Maximum

integer

No

The maximum number of times an alert notification can be sent within a calendar day. Valid values: [1, 10000].

3
Channels

array

No

The alert notification channels.

string

No

The alert notification channel. Valid values:

  • Mail

  • Phone

  • Sms: text message

  • Dingding: DingTalk

  • Feishu: Lark

  • Weixin: WeCom

  • Webhook: custom webhook

Sms
Receivers

array<object>

No

The alert recipients.

object

No

ReceiverType

string

No

The type of the alert recipient. Valid valves:

  • AliUid: Alibaba Cloud account ID.

  • Shift Schedules: the personnel in a shift schedule.

  • TaskOwner: the task owner. The task owner can receive custom alerts and event alerts.

  • Owner: the baseline owner. The baseline owner can receive baseline alerts.

  • WebhookUrl: URL of a custom webhook.

  • DingdingUrl: DingTalk webhook URL.

  • FeishuUrl: Lark webhook URL.

  • WeixinUrl: WeCom webhook URL.

TaskOwner
ReceiverValues

array

No

The alert recipients.

string

No

The ID of the alert recipient. If the ReceiverType parameter is set to AliUid, set this parameter to an Alibaba Cloud account ID. If the ReceiverType parameter is set to ShiftSchedule, set this parameter to a shift schedule ID. If the ReceiverType parameter is set to WebhookUrl, DingdingUrl, FeishuUrl, or WeixinUrl, set this parameter to a corresponding URL.

123123
Extension

string

No

The additional configuration of the alert recipient. If the ReceiverType parameter is set to DingdingUrl, you can set this parameter to {"atAll":true} to remind all members in a DingTalk group.

{"atAll":true}

Response elements

Element

Type

Description

Example

object

The response parameters.

RequestId

string

The request ID.

D85FEE2B-6174-5817-AF9E-FDD02FEDA5BC
Success

boolean

Indicates whether the request was successful.

true

Examples

Success response

JSON format

{
  "RequestId": "D85FEE2B-6174-5817-AF9E-FDD02FEDA5BC",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.