Modifies a custom alert rule.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | UpdateRemind |
The operation that you want to perform. |
RegionId | String | Yes | cn-shanghai |
The ID of the region in which you want to modify a custom alert rule. For example, the ID of the China (Shanghai) region is cn-shanghai, and that of the China (Zhangjiakou) region is cn-zhangjiakou. The system automatically determines the value of this parameter based on the endpoint used to call the operation. |
RemindId | Long | Yes | 1234 |
The ID of the custom alert rule. |
RemindName | String | No | update_remindname |
The name of the custom alert rule. The name can be a maximum of 128 characters in length. |
DndEnd | String | No | 08:00 |
The end of the period during which no alert notifications are sent. Specify a value in the hh:mm format. Valid values of hh: 0 to 23. Valid values of mm: 0 to 59. |
RemindUnit | String | No | NODE |
The type of the object to be monitored. Valid values:
|
NodeIds | String | No | 1,2,3 |
The ID of the node to be monitored. An alert rule can monitor a maximum of 50 nodes. Separate multiple IDs with commas (,). This parameter is available if you set the RemindUnit parameter to NODE. |
BaselineIds | String | No | 1,2,3 |
The ID of the baseline to be monitored. An alert rule can monitor a maximum of five baselines. Separate multiple IDs with commas (,). This parameter is available if you set the RemindUnit parameter to BASELINE. |
ProjectId | Long | No | 1234 |
The ID of the workspace to be monitored. An alert rule can monitor only one workspace. This parameter is available if you set the RemindUnit parameter to PROJECT. |
BizProcessIds | String | No | 1,2,3 |
The ID of the workflow to be monitored. An alert rule can monitor a maximum of five workflows. Separate multiple IDs with commas (,). This parameter is available if you set the RemindUnit parameter to BIZPROCESS. |
RemindType | String | No | FINISHED |
The condition that triggers the alert rule. Valid values:
For more information, see Manage custom alert rules. |
MaxAlertTimes | Integer | No | 3 |
The maximum number of alert notifications that can be sent. Valid values: 1 to 10. Default value: 3. |
AlertInterval | Integer | No | 1800 |
The intervals at which alert notifications are sent. Unit: seconds. Minimum value: 1200. Default value: 1800. |
Detail | String | No | null |
The value format required by this parameter varies based on the value that you specify for the RemindType parameter. Take note of the following items:
|
AlertUnit | String | No | OWNER |
The recipient to whom alert notifications are sent. Valid values: OWNER and OTHER. A value of OWNER indicates that alert notifications are sent to the object owner. A value of OTHER indicates that alert notifications are sent to a specified user. |
AlertMethods | String | No | SMS, MAIL |
The notification method. Valid values:
You can specify multiple notification methods. Separate them with commas (,). |
AlertTargets | String | No | 9527952795279527 |
The value format required by this parameter varies based on the value that you specify for the AlertUnit parameter. Take note of the following items:
|
UseFlag | Boolean | No | true |
Specifies whether to enable the alert rule. Valid values:
|
RobotUrls | String | No | https://oapi.dingtalk.com/robot/send?access_token=****************************** |
The webhook URL of the DingTalk chatbot. You can specify multiple webhook URLs. Separate them with commas (,). If this parameter is set to undefined, the specified webhook URLs are cleared. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
Data | Boolean | true |
Indicates whether the modification to the custom alert rule succeeds. |
ErrorCode | String | 1031203110005 |
The error code that is returned. |
ErrorMessage | String | The specified parameters are invalid. |
The error message that is returned. |
HttpStatusCode | Integer | 200 |
The HTTP status code that is returned. |
RequestId | String | 0000-ABCD-EFG**** |
The unique ID of the request. You can use the ID to troubleshoot issues. |
Success | Boolean | true |
Indicates whether the request is successful. Valid values:
|
Examples
Sample requests
http(s)://[Endpoint]/?Action=UpdateRemind
&RegionId=cn-shanghai
&RemindId=1234
&<Common request parameters>
Sample success responses
XML
format
<RequestId>0000-ABCD-EFG****</RequestId>
<HttpStatusCode>200</HttpStatusCode>
<Data>true</Data>
<ErrorCode>1031203110005</ErrorCode>
<ErrorMessage>The specified parameters are invalid.</ErrorMessage>
<Success>true</Success>
JSON
format
{
"RequestId": "0000-ABCD-EFG****",
"HttpStatusCode": 200,
"Data": true,
"ErrorCode": 1031203110005,
"ErrorMessage": "The specified parameters are invalid.",
"Success": true
}
Error codes
Http status code | Error code | Error message | Description |
---|---|---|---|
429 | Throttling.Api | The request for this resource has exceeded your available limit. | The error message returned because the number of requests for the resource has reached the upper limit. |
429 | Throttling.Api.Risk | The request for this resource has exceeded your daily available limit. | The error message returned because the number of requests per day for the resource has reached the upper limit. |
429 | Throttling.Resource | You have reached the limit for the resource. Please contact us by submitting a ticket. | The error message returned because your quota for the resource has reached the upper limit. Submit a ticket for help. |
429 | Throttling.System | The DataWorks system is busy. Try again later. | The error message returned because the DataWorks system is busy. Try again later. |
429 | Throttling.User | Your request is too frequent. Try again later. | The error message returned because excessive requests have been submitted within a short period of time. Try again later. |
500 | Forbidden.Not.Server | The dataworksAPI service is not available in this area. Please try it in another area. | The error message returned because the DataWorks API is unavailable in this region. Try another region. |
500 | Forbidden.Wkbench.BaselineNoPermission | You are not authorized to access the baseline. | The error message returned because you are not authorized to access the specified baseline. |
500 | Forbidden.Wkbench.ProjectNoPermission | You are not authorized to access the workspace. | The error message returned because you are not authorized to access the specified workspace. |
500 | InternalError.System | An internal system error occurred. Try again later. | The error message returned because an internal error occurred. Try again later. |
500 | InternalError.UserId.Missing | An internal system error occurred. Try again later. | The error message returned because an internal error occurred. Try again later. |
500 | Forbidden.Wkbench.RemindNoPermission | You are not authorized to modify the reminder. | The error message returned because you are not authorized to modify the custom alert rule. |
500 | Invalid.Wkbench.RemindNotExist | The reminder does not exist. | The error message returned because the specified custom alert rule does not exist. |
For a list of error codes, visit the API Error Center.