| object | | |
| HttpStatusCode | integer | | 200 |
| RequestId | string | | 0000-ABCD-EFGH-IJKLMNOPQ |
| ErrorMessage | string | | The specified parameters are invalid. |
| ErrorCode | string | | 1031203110005 |
| Success | boolean | Indicates whether the request was successful. | true |
| Data | object | The details of the custom alert rule. | |
| MaxAlertTimes | integer | The maximum number of alerts. | 3 |
| RemindUnit | string | The type of the object to which the custom alert rule is applied. Valid values: NODE, BASELINE, PROJECT, and BIZPROCESS. The value NODE indicates a node. The value BASELINE indicates a baseline. The value PROJECT indicates a workspace. The value BIZPROCESS indicates a workflow. | NODE |
| AlertInterval | integer | The minimum interval at which alerts are reported. Unit: seconds. | 1800 |
| Useflag | boolean | Indicates whether the custom alert rule is enabled. Valid values: true and false. | true |
| Founder | string | The ID of the Alibaba Cloud account used by the creator of the custom alert rule. | 9527951795**** |
| RemindId | long | The custom alert rule ID. | 1234 |
| DndEnd | string | The end time of the quiet hours. The value is in the hh:mm format. Valid values of hh: [0,23]. Valid values of mm: [0,59]. | 08:00 |
| RemindType | string | The conditions that trigger an alert. Valid values: FINISHED, UNFINISHED, ERROR, CYCLE_UNFINISHED, and TIMEOUT. | FINISHED |
| AlertUnit | string | The type of the alert recipient. For more information about alert recipient types, see the Receivers parameter. Valid values: - OWNER: the task owner
- OTHER: specified personnel
- SHIFT_SCHEDULE: personnel in a shift schedule
| OWNER |
| DndStart | string | The start time of the quiet hours. The value is in the hh:mm format. Valid values of hh: [0,23]. Valid values of mm: [0,59]. | 00:00 |
| RemindName | string | | Rule name |
| Detail | string | - If the value of the RemindType parameter is FINISHED, this parameter is left empty.
- If the value of the RemindType parameter is UNFINISHED, the trigger conditions are returned as key-value pairs. Example: {"hour":23,"minu":59}. Valid values of hour: [0,47]. Valid values of minu: [0,59].
- If the value of the RemindType parameter is ERROR, this parameter is left empty.
- If the value of the RemindType parameter is CYCLE_UNFINISHED, the trigger conditions are returned as key-value pairs. Example: {"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 indicates the ID of the cycle. Valid values: [1,288]. The value indicates the timeout period of the node that is running in the cycle. Specify the value in the hh:mm format. Valid values of hh: [0,47]. Valid values of mm: [0,59].
- If the value of the RemindType parameter is TIMEOUT, the timeout period is returned. Unit: seconds. Example: 1800. This value indicates that an alert is reported if the node has run for more than 30 minutes.
| {"hour":23,"minu":59} |
| Robots | array<object> | The webhook URLs of the DingTalk chatbots. | |
| Robots | object | | |
| WebUrl | string | The webhook URL of the DingTalk chatbot. | https://oapi.dingtalk.com/robot/send?access_token=****************************** |
| AtAll | boolean | Indicates whether all group members are notified when the alert notification is sent to a DingTalk group. Valid values: true and false. | true |
| Nodes | array<object> | The nodes to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is NODE. | |
| Nodes | object | | |
| Owner | string | The ID of the Alibaba Cloud account used by the node owner. | 9527951795**** |
| NodeName | string | | Node name |
| NodeId | long | | 1234 |
| ProjectId | long | The ID of the workspace to which the node belongs. | 1234 |
| Baselines | array<object> | The baselines to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is BASELINE. | |
| Baselines | object | | |
| BaselineName | string | The name of the baseline. | Baseline name |
| BaselineId | long | | 1234 |
| Projects | array<object> | The workspaces to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is PROJECT. | |
| Projects | object | | |
| ProjectId | long | | 1234 |
| BizProcesses | array<object> | The workflows to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is BIZPROCESS. | |
| BizProcesses | object | | |
| BizProcessName | string | The name of the workflow. | Business process name |
| BizId | long | | 9527 |
| AlertTargets | array | The description of the alert recipient. For more information about alert recipients, see the Receivers parameter. | |
| AlertTargets | string | - If the value of the AlertUnit parameter is OWNER, this parameter is left empty.
- If the value of the AlertUnit parameter is OTHER, the ID of the Alibaba Cloud account used by the specified user is returned.
- If the value of the AlertUnit parameter is SHIFT_SCHEDULE, the shift schedule ID is returned.
| 9527952795279527 |
| AlertMethods | array | | |
| AlertMethods | string | The notification method. Valid values: - MAIL
- SMS
- Alert notifications can be sent by text message only in the Singapore, Malaysia (Kuala Lumpur), and Germany (Frankfurt) regions.
| SMS,MAIL |
| Webhooks | array | | |
| Webhooks | string | The webhook URL of the WeCom or Lark chatbot. You must specify Webhooks for AlertMethods. Only DataWorks Enterprise Edition supports this parameter. | https://open.feishu.cn/open-apis/bot/v2/hook/******* |
| Receivers | array<object> | The information about the alert recipients. | |
| Receivers | object | The information about the alert recipient. | |
| AlertUnit | string | The type of the alert recipient. For more information about alert recipients, see the Receivers parameter. Valid values: - OWNER: indicate the task owner.
- OTHER: indicates specified personnel.
- SHIFT_SCHEDULE: indicates personnel in a shift schedule.
| OWNER |
| AlertTargets | array | | |
| AlertTargets | string | - If the value of the AlertUnit parameter is OWNER, this parameter is left empty.
- If the value of the AlertUnit parameter is OTHER, the ID of the Alibaba Cloud account used by the specified user is returned.
- If the value of the AlertUnit parameter is SHIFT_SCHEDULE, the shift schedule ID is returned.
| 9527952795279527 |
| AllowNodes | array | The IDs of the nodes that are added to a whitelist. | |
| allowNodes | long | The ID of the node that is added to a whitelist. The nodes that you add to the whitelist are not monitored. | 123 |
