All Products
Search

This Product

    DataWorks:UpdateRemind

    Document Center

    DataWorks:UpdateRemind

    Last Updated:Jul 31, 2026

    Updates a custom 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
    RemindId

    integer

    Yes

    The ID of the custom rule.

    1234
    RemindName

    string

    No

    The name of the custom rule. The name cannot exceed 128 characters in length.

    update_remindname
    DndEnd

    string

    No

    The end time of the do-not-disturb period. Alerts are not sent before this time. Format: hh:mm. Valid values of hh: [0,23]. Valid values of mm: [0,59].

    08:00
    RemindUnit

    string

    No

    The type of the monitored object. Valid values:

    • NODE

    • BASELINE

    • PROJECT (workspace)

    • BIZPROCESS (business process)

    Valid values:

    • BASELINE :

      baseline.

    • PROJECT :

      workspace.

    • NODE :

      node.

    • BIZPROCESS :

      business process.

    NODE
    NodeIds

    string

    No

    The node IDs when the monitored object is a node. A rule can monitor up to 50 nodes. Separate multiple node IDs with commas (,). This parameter takes effect only when RemindUnit is set to NODE.

    1,2,3
    BaselineIds

    string

    No

    The baseline IDs when the monitored object is a baseline. A rule can monitor up to 5 baselines. Separate multiple baseline IDs with commas (,). This parameter takes effect only when RemindUnit is set to BASELINE.

    1,2,3
    ProjectId

    integer

    No

    The workspace ID when the monitored object is a workspace. A rule can monitor only one workspace. This parameter takes effect only when RemindUnit is set to PROJECT.

    1234
    BizProcessIds

    string

    No

    The business process IDs when the monitored object is a business process. A rule can monitor up to 5 business processes. Separate multiple business process IDs with commas (,). This parameter takes effect only when RemindUnit is set to BIZPROCESS.

    1,2,3
    RemindType

    string

    No

    The condition that triggers the alert rule. Valid values:

    • FINISHED: The system monitors the instance from the start time and sends an alert when the node runs successfully.

    • UNFINISHED: The system monitors the instance from the start time and sends an alert if the node has not finished running by the specified target time.

    • ERROR: The system monitors the instance from the start time and sends an alert when the node encounters an error.

    • CYCLE_UNFINISHED: The system sends an alert if the instance has not finished running within the specified cycle. This is typically used to monitor instances that run on an hourly cycle.

    • TIMEOUT: The system monitors the instance from the start time and sends an alert if the node has not finished running after the specified duration. This is typically used to monitor the running duration of instances.

    For more information about alert trigger conditions, see Custom rules.

    FINISHED
    MaxAlertTimes

    integer

    No

    The maximum number of alerts. Valid values: [1,10]. Default value: 3.

    3
    AlertInterval

    integer

    No

    The alert interval, in seconds. Minimum value: 1200. Default value: 1800.

    1800
    Detail

    string

    No

    The configuration details for different trigger conditions:

    • When RemindType (trigger condition) is set to FINISHED, the configuration is left empty.

    • When RemindType (trigger condition) is set to UNFINISHED, the configuration format is {"hour":23,"minu":59}. Valid values of hour: [0,47]. Valid values of minu: [0,59].

    • When RemindType (trigger condition) is set to ERROR, the configuration is left empty.

    • When RemindType (trigger condition) is set to CYCLE_UNFINISHED (cycle unfinished), the configuration format is {"1":"05:50","2":"06:50","3":"07:50","4":"08:50","5":"09:50","6":"10:50","7":"11:50","8":"12:50","9":"13:50","10":"14:50","11":"15:50","12":"16:50","13":"17:50","14":"18:50","15":"19:50","16":"20:50","17":"21:50","18":"22:50","19":"23:50","20":"24:50","21":"25:50"}. The key in the JSON string is the cycle number. Valid values: [1,288]. The value is the unfinished time for the corresponding cycle in the format hh:mm. Valid values of hh: [0,47]. Valid values of mm: [0,59].

    • When RemindType (trigger condition) is set to TIMEOUT, the configuration format is 1800, in seconds. This means an alert is triggered if the instance has been running for more than 30 minutes.

    {"hour":23,"minu":59}
    AlertUnit

    string

    No

    The recipient of the alert. Valid values:

    • OWNER: the node owner.

    • OTHER: a specified user.

    Valid values:

    • OTHER :

      a specified user.

    • OWNER :

      the node owner.

    OWNER
    AlertMethods

    string

    No

    The alert notification method. Valid values:

    • MAIL

    • SMS

    • PHONE. Only DataWorks Professional Edition and higher support phone alerts.

    • DINGROBOTS (DingTalk chatbot). This method takes effect only after the RobotUrls parameter is configured.

    • Webhooks (WeCom or Lark chatbot). This method takes effect only after the Webhooks parameter is configured.

    Separate multiple alert methods with commas (,).

    SMS,MAIL
    AlertTargets

    string

    No

    The configuration details for different alert recipients:

    • When AlertUnit is set to OWNER (node owner), the configuration is left empty.

    • When AlertUnit is set to OTHER (specified user), set this parameter to the Alibaba Cloud UIDs of the specified users. Separate multiple UIDs with commas (,). You can specify up to 10 users to receive alerts.

    9527952795279527
    UseFlag

    boolean

    No

    Specifies whether to enable the alert rule. Valid values:

    • true: Enabled.

    • false: Disabled.

    true
    RobotUrls

    string

    No

    The webhook URLs of DingTalk group chatbots. Separate multiple webhook URLs with commas (,). When the parameter settings are set to undefined, the system clears the DingTalk chatbot webhook URLs.

    https://oapi.dingtalk.com/robot/send?access_token=******************************
    Webhooks

    string

    No

    The webhook URLs of WeCom or Lark chatbots. Separate multiple webhook URLs with commas (,). The alertMethods parameter must include the WEBHOOKS alerting method. When the parameter is set to undefined, the system clears the webhook URLs.

    Only DataWorks Enterprise Edition is supported. Active regions: China (Shanghai), China (Chengdu), China (Zhangjiakou), China (Beijing), China (Hangzhou), China (Shenzhen), Hong Kong (China), Germany (Frankfurt), Asia-Pacific Southeast 1 (Singapore).

    https://open.feishu.cn/open-apis/bot/v2/hook/*******

    Response elements

    Element

    Type

    Description

    Example

    object

    HttpStatusCode

    integer

    The HTTP status code.

    200
    Data

    boolean

    The result of updating the custom monitoring rule.

    true
    ErrorMessage

    string

    The error message.

    The specified parameters are invalid.
    RequestId

    string

    The unique ID of the request. You can use this ID to troubleshoot issues.

    0000-ABCD-EFG****
    Success

    boolean

    Indicates whether the call was successful. Valid values:

    • true: Successful.

    • false: Failed.

    true
    ErrorCode

    string

    The error code.

    1031203110005

    Examples

    Success response

    JSON format

    {
  "HttpStatusCode": 200,
  "Data": true,
  "ErrorMessage": "The specified parameters are invalid.",
  "RequestId": "0000-ABCD-EFG****",
  "Success": true,
  "ErrorCode": "1031203110005"
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    500 Forbidden.Not.Server The dataworksAPI service is not available in this area. Please try it in another area.
    500 Forbidden.Wkbench.BaselineNoPermission You are not authorized to access the baseline.
    500 Forbidden.Wkbench.ProjectNoPermission You are not authorized to access the workspace.
    500 InternalError.System An internal system error occurred. Try again later.
    500 InternalError.UserId.Missing An internal system error occurred. Try again later.
    500 Forbidden.Wkbench.RemindNoPermission You are not authorized to modify the reminder.
    500 Invalid.Wkbench.RemindNotExist The reminder does not exist.
    429 Throttling.Api The request for this resource has exceeded your available limit.
    429 Throttling.Api.Risk The request for this resource has exceeded your daily available limit.
    429 Throttling.Resource You have reached the limit for the resource. Please contact us by submitting a ticket.
    429 Throttling.System The DataWorks system is busy. Try again later.
    429 Throttling.User Your request is too frequent. Try again later.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.