Queries custom alert rules.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | ListReminds |
The operation that you want to perform. |
PageNumber | Integer | Yes | 1 |
The number of pages that are returned. The default value is 1, the minimum value is 1, and the maximum value is 30. |
PageSize | Integer | Yes | 10 |
The number of entries to return on each page. Default value: 10. Maximum value: 100. |
RegionId | String | Yes | cn-shanghai |
The unique identifier of the zone. |
Founder | String | No | 9527952795**** |
The Alibaba Cloud UID of the project creator. |
NodeId | Long | No | 1234 |
The object of the rule. You can search for custom monitoring rules that override the task node by node ID. |
RemindTypes | String | No | FINISHED,ERROR |
The trigger condition, including FINISHED, UNFINISHED, ERROR, CYCLE_UNFINISHED, and TIMEOUT. Separate multiple trigger conditions with commas (,). |
AlertTarget | String | No | 9527952795**** |
The Alibaba Cloud UID of the alert recipient. |
SearchText | String | No | Fuzzy match rule name |
The name of the search rule. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
Data | Struct |
The list of returned custom monitoring rules. |
|
PageNumber | Integer | 1 |
The current page number. |
PageSize | Integer | 10 |
The size of each page. |
Reminds | Array of Reminds |
The list of custom monitoring rules. |
|
AlertMethods | List | SMS |
The alert method. Valid values: MAIL, SMS, and PHONE. PHONE number: DataWorks Professional Edition and later. |
AlertTargets | List | 952795**** |
The Alibaba Cloud UID list of the alert recipient. |
AlertUnit | String | OWNER |
The granularity of the object that is used to receive alerts. Valid values: OWNER and OTHER. |
BaselineIds | List | 9527 |
The ID of the BASELINE to monitor when the value of the credunit parameter is BASELINE. |
BizProcessIds | List | 9527 |
The ID of the baseline to be monitored when the value of workflow is BIZPROCESS. |
DndEnd | String | 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]. |
DndStart | String | 00:00 |
The start time for the default disturb mode. The format is hh:mm. The value range of hh is [0,23]. The value range of mm is [0,59]. |
Founder | String | 952795**** |
The Alibaba Cloud UID of the rule creator. |
NodeIds | List | 1234 |
The IDs of the nodes to be monitored. This parameter is required when the primary_id_type parameter is set to NODE. |
ProjectIds | List | 1234 |
The IDs of the nodes to be monitored when the value of represent is PROJECT. |
RemindId | Long | 1234 |
The ID of the custom monitoring rule. |
RemindName | String | Rule Name |
The name of the custom monitoring rule. |
RemindType | String | FINISHED |
The trigger condition, including FINISHED, UNFINISHED, ERROR, CYCLE_UNFINISHED, and TIMEOUT. |
RemindUnit | String | NODE |
The type of the object. Valid values: NODE, BASELINE, PROJECT, and workflow. |
Useflag | Boolean | true |
Indicates whether the rule is enabled. Valid values: true and false. |
TotalCount | Integer | 100 |
The total number of custom monitoring rules. |
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=listelements&PageNumber=1 &PageSize=10 &RegionId=cn-shanghai &<common request parameters>
Sample success responses
XML
format
<RequestId> 0000-abcd-efg**** </RequestId> <HttpStatusCode> 200 </HttpStatusCode> <Data> <TotalCount> 100 </TotalCount> <PageSize> 10 </PageSize> <PageNumber> 1 </PageNumber> <Reminds> <RemindId> 1234 </RemindId> <DndStart> 00:00 </DndStart> <DndEnd> 08:00 </DndEnd> <AlertUnit> OWNER </AlertUnit> <RemindUnit> NODE </RemindUnit> <RemindType> FINISHED </RemindType> <Useflag> true </Useflag> <Founder> 952795 **** </Founder> <RemindName> rule name </RemindName> </Reminds> <Reminds> <BizProcessIds> 1234 </BizProcessIds> <NodeIds> 1234 </NodeIds> <AlertMethods> SMS </AlertMethods> <ProjectIds> 1234 </ProjectIds> <BaselineIds> 1234 </BaselineIds> <AlertTargets> 952795**** </AlertTargets> </Reminds> </Data> <ErrorCode> 1031203110005 </ErrorCode> <ErrorMessage> The specified parameters are invalid. </ErrorMessage> <Success>true</Success>
JSON
Format
{"RequestId": "0000-ABCD-EFG****", "HttpStatusCode": 200, "Data": { "TotalCount": 100, "PageSize": 10, "PageNumber": 1, "Reminds": [ { "RemindId": 1234, "DndStart": "00:00", "DndEnd": "08:00", "AlertUnit": "OWNER"," Memordunit ": " NODE ", " memordtype ": " FINISHED ", " Useflag ": true, " Founder ": " 952795 ${{* ", " memordname ": " Rule name "}, { " BizProcessIds ": 1234, " NodeIds ": 1234," alalertmethod ": SMS", "ProjectIds": 1234, "BaselineIds": 1234, "AlertTargets": "952795****" } ] }, "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 | 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. |
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.