Creates a custom alert rule.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | CreateRemind |
The operation that you want to perform. |
AlertUnit | String | Yes | OWNER |
The granularity of the object that is used to receive alerts. Valid values: OWNER and OTHER. |
RegionId | String | Yes | cn-shanghai |
The unique identifier of the zone. |
RemindName | String | Yes | test_error_remind |
The name of the rule. The name must be 1 to 128 characters in length. |
RemindType | String | Yes | FINISHED |
The trigger condition, including FINISHED, UNFINISHED, ERROR, CYCLE_UNFINISHED, and TIMEOUT. |
RemindUnit | String | Yes | NODE |
The type of the object. Valid values: NODE, BASELINE, PROJECT, and workflow. |
DndEnd | String | No | 08:00 |
The skip end time. The time is in the hh:mm format. The value range of hh is [0,23]. The value range of mm is [0,59]. |
NodeIds | String | No | 1,2,3 |
The ID of the task NODE to be monitored when the value of represent is NODE. Separate multiple IDs with commas (,). A rule can monitor up to 50 nodes. |
BaselineIds | String | No | 1,2,3 |
The ID of the BASELINE to monitor when the value of the credunit parameter is BASELINE. Separate multiple IDs with commas (,). A rule monitors up to five baselines. |
ProjectId | Long | No | 9527 |
The ID of the workspace to be monitored when the value of the mindunit (object type) parameter is PROJECT. A rule can only monitor one workspace. |
BizProcessIds | String | No | 1,2,3 |
The number of workflow to be monitored when workflow is set to BIZPROCESS (ID.). Separate multiple workflow IDs with commas (,). A rule can contain up to five workflow. |
MaxAlertTimes | Integer | No | 2 |
Maximum number of alarms. Valid values: 1 and 10. Default value: 3. |
AlertInterval | Integer | No | 1800 |
The minimum alert interval. Unit: seconds. The minimum value is 1200 and the default value is 1800. |
Detail | String | No | {"hour":23,"minu":59} |
The different trigger conditions are described as follows:
|
AlertMethods | String | No | SMS,MAIL |
The alert method. Valid values: MAIL, SMS, and PHONE. PHONE number: DataWorks Professional Edition and later. Separate multiple notification methods with commas (,). |
AlertTargets | String | No | 9527952795279527 |
|
RobotUrls | String | No | https://oapi.dingtalk.com/robot/send?access_token=****************************** |
DingTalk the webhook address of the chatbot. Separate multiple webhook addresses with commas (,). |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
Data | Long | 1234 |
The ID of the newly created monitoring rule. |
ErrorCode | String | 1031203110005 |
The error code. |
ErrorMessage | String | The specified parameters are invalid. |
The error message. |
HttpStatusCode | Integer | 200 |
The HTTP status code. |
RequestId | String | 0000-ABCD-EFG**** |
The unique ID of the call. You can use the error ID to troubleshoot the error. |
Success | Boolean | true |
Indicates whether the request was successful. |
Examples
Sample requests
http(s)://[Endpoint]/? Action=CreateRemind &AlertUnit=OWNER &RegionId=cn-shanghai &RemindName=test_error_remind&memordtype=FINISHED&memordunit=NODE &<common request parameters>
Sample success responses
XML
format
<RequestId>0000-ABCD-EFG****</RequestId> <HttpStatusCode>200</HttpStatusCode> <Data>9527</Data> <ErrorCode>1031203110005</ErrorCode> <ErrorMessage>The specified parameters are invalid. </ErrorMessage> <Success>true</Success>
JSON
Format
{ "RequestId": "0000-ABCD-EFG****", "HttpStatusCode": 200, "Data": 9527, "ErrorCode": 1031203110005, "ErrorMessage": "The specified parameters are invalid.", "Success": true }
Error codes
HttpCode | Error codes | Error message | Description |
---|---|---|---|
500 | Forbidden.Not.Server | The dataworksAPI service is not available in this area. Please try it in another area. | DataWorks API service is not available in this region. Please try another region. |
500 | Forbidden.Wkbench.BaselineNoPermission | You are not authorized to access the baseline. | No baseline permissions exist. |
500 | Forbidden.Wkbench.ProjectNoPermission | You are not authorized to access the workspace. | You have no permission to use a workspace. |
500 | InternalError.System | An internal system error occurred. Try again later. | An internal system error occurred. Please try again later. |
500 | InternalError.UserId.Missing | An internal system error occurred. Try again later. | An internal system error occurred. Please try again later. |
500 | InternalError.Wkbench.ServiceError | An internal error occurred. | The service was open. |
500 | Invalid.Wkbench.Parameter | The specified parameters are invalid. | One or more parameters are invalid. |
429 | Throttling.Api | The request for this resource has exceeded your available limit. | The request for the resource exceeds your available upper limit. |
429 | Throttling.Api.Risk | The request for this resource has exceeded your daily available limit. | The request for the resource has exceeded your daily availability limit. |
429 | Throttling.Resource | You have reached the limit for the resource. Please contact us by submitting a ticket. | The number of resources has reached the upper limit. Submit a ticket. |
429 | Throttling.System | The DataWorks system is busy. Try again later. | DataWorks the system is busy, please try again later. |
429 | Throttling.User | Your request is too frequent. Try again later. | Your request is too frequent, please try to slow down the request speed. |
500 | Forbidden.Wkbench.NoProject | You have not joined any project. | You have not joined any workspaces. |
500 | Invalid.Wkbench.NodeNotExist | The node does not exist. | The node does not exist. |
500 | Invalid.Wkbench.BaselineNotExist | The baseline does not exist. | The specified baseline does not exist. |
500 | Forbidden.Wkbench.RemindOverlimit | The maximum number of reminders is exceeded. | The error message returned because the maximum number of custom reminder rules has been exceeded. |
403 | Forbidden.Access | Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. | You have restricted access. Please activate DataWorks Enterprise Edition or above. |
Go to the Error CenterFor more information, see error codes.