Creates a custom alert rule.
Debugging
Authorization information
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RemindName | string | Yes | The name of the custom alert rule. The name cannot exceed 128 characters in length. | test_error_remind |
| DndEnd | string | No | The end time of the quiet hours. Specify the time in the hh:mm format. Valid values of hh: [0,23]. Valid values of mm: [0,59]. | 08:00 |
| RemindUnit | string | Yes | 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 |
| NodeIds | string | No | The ID of the node to which the custom alert rule is applied. This parameter takes effect when the RemindUnit parameter is set to NODE. You can specify multiple IDs. Separate multiple IDs with commas (,). A maximum of 50 nodes can be specified for a custom alert rule. | 1,2,3 |
| BaselineIds | string | No | The ID of the baseline to which the custom alert rule is applied. This parameter takes effect when the RemindUnit parameter is set to BASELINE. You can specify multiple IDs. Separate multiple IDs with commas (,). A maximum of five baselines can be specified for a custom alert rule. | 1,2,3 |
| ProjectId | long | No | The ID of the workspace to which the custom alert rule is applied. This parameter takes effect when the RemindUnit parameter is set to PROJECT. You can specify only one workspace for a custom alert rule. | 9527 |
| BizProcessIds | string | No | The ID of the workflow to which the custom alert rule is applied. This parameter takes effect when the RemindUnit parameter is set to BIZPROCESS. You can specify multiple IDs. Separate multiple IDs with commas (,). A maximum of five workflows can be specified for a custom alert rule. | 1,2,3 |
| RemindType | string | Yes | The conditions that trigger an alert. Valid values: FINISHED, UNFINISHED, ERROR, CYCLE_UNFINISHED, and TIMEOUT. | FINISHED |
| MaxAlertTimes | integer | No | The maximum number of alerts. Valid values: 1 to 10. Default value: 3. | 2 |
| AlertInterval | integer | No | The minimum interval at which alerts are reported. Unit: seconds. Minimum value: 1200. Default value: 1800. | 1800 |
| Detail | string | No | The details of the conditions that trigger an alert.
| {"hour":23,"minu":59} |
| AlertUnit | string | Yes | The recipient of the alert. Valid values: OWNER and OTHER. The value OWNER indicates the node owner. The value OTHER indicates a specified user. | OWNER |
| AlertMethods | string | Yes | The notification method. Valid values:
You can specify multiple notification methods. Separate them with commas (,). | SMS,MAIL |
| AlertTargets | string | No |
| 9527952795279527 |
| RobotUrls | string | No | The webhook URL of the DingTalk chatbot. You can specify multiple webhook URLs. Separate multiple webhook URLs with commas (,). | https://oapi.dingtalk.com/robot/send?access_token=****************************** |
| Webhooks | string | No | The webhook URL of the WeCom or Lark chatbot. You can specify multiple webhook URLs. Separate multiple webhook URLs with commas (,). You must specify WEBHOOKS for AlertMethods. Only DataWorks Enterprise Edition supports this parameter. The webhook URL-based alerting feature is supported in the following regions: China (Shanghai), China (Chengdu), China (Zhangjiakou), China (Beijing), China (Hangzhou), China (Shenzhen), China (Hong Kong), Germany (Frankfurt), and Singapore. | https://open.feishu.cn/open-apis/bot/v2/hook/******* |
Response parameters
Examples
Sample success responses
JSONformat
{
"HttpStatusCode": 200,
"Data": 1234,
"ErrorMessage": "The specified parameters are invalid.",
"RequestId": "0000-ABCD-EFG****",
"Success": true,
"ErrorCode": "1031203110005"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 403 | Forbidden.Access | Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. | No permission, please authorize |
| 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. | - |
| 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. | You are not authorized to access the baseline. |
| 500 | Forbidden.Wkbench.ProjectNoPermission | You are not authorized to access the workspace. | 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.NoProject | You have not joined any project. | You have not joined any project. |
| 500 | Invalid.Wkbench.NodeNotExist | The node does not exist. | The node does not exist. |
| 500 | Invalid.Wkbench.BaselineNotExist | The baseline does not exist. | The baseline does not exist. |
| 500 | Forbidden.Wkbench.RemindOverlimit | The maximum number of reminders is exceeded. | The maximum number of reminders is exceeded. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|