Query a list of custom alert rules with ListReminds - DataWorks - Alibaba Cloud - DataWorks

Queries a list of custom alert rules.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	Yes	The number of the page to return. Valid values: 1 to 30. Default value: 1.	1
PageSize	integer	Yes	The number of entries to return on each page. Default value: 10. Maximum value: 100.	10
Founder	string	No	The ID of the Alibaba Cloud account that is used to create the custom alert rules.	9527952795****
NodeId	integer	No	The ID of the node to which the custom alert rules are applied. You can use the ID to search for the custom alert rules that are applied to the node.	1234
RemindTypes	string	No	The conditions that trigger an alert for the node. Valid values: FINISHED, UNFINISHED, ERROR, CYCLE_UNFINISHED, and TIMEOUT. The value FINISHED indicates that the node finishes running. The value UNFINISHED indicates that the node is still running at the specified point in time. The value ERROR indicates that an error occurs when the node is running. The value CYCLE_UNFINISHED indicates that the node does not finish running in the specified scheduling cycle. The value TIMEOUT indicates that the node times out. You can specify multiple conditions for a custom alert rule. If you specify multiple condition, separate them with commas (,).	FINISHED,ERROR
AlertTarget	string	No	The ID of the Alibaba Cloud account that is used to receive alert notifications.	9527952795****
SearchText	string	No	The keyword in a rule name that is used to search for the rule. Fuzzy search is supported.	Fuzzy search by rule name

Response elements

Element	Type	Description	Example
	object
HttpStatusCode	integer	The HTTP status code returned.	200
RequestId	string	The ID of the request. You can use the ID to troubleshoot issues.	0000-ABCD-EFG****
ErrorMessage	string	The error message returned.	The specified parameters are invalid.
ErrorCode	string	The error code returned.	1031203110005
Success	boolean	Indicates whether the request was successful.	true
Data	object	The data returned.
PageNumber	integer	The page number of the returned page.	1
PageSize	integer	The number of entries returned per page.	10
TotalCount	integer	The total number of custom alert rules returned.	100
Reminds	array<object>	The list of custom alert rules.
	object
Founder	string	The ID of the Alibaba Cloud account used by the rule creator.	952795****
RemindId	integer	The custom alert rule ID.	1234
AlertUnit	string	The alert recipient. Valid values: OWNER and OTHER. The value OWNER indicates the node owner. The value OTHER indicates a specified user.	OWNER
RemindType	string	The condition that triggers an alert. Valid values: FINISHED, UNFINISHED, ERROR, CYCLE_UNFINISHED, and TIMEOUT.	FINISHED
DndEnd	string	The end time of the quiet hours. The time is in the hh:mm format. Valid values of hh: [0,23]. Valid values of mm: [0,59].	08:00
DndStart	string	The start time of the quiet hours. The time is in the hh:mm format. Valid values of hh: [0,23]. Valid values of mm: [0,59].	00:00
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
Useflag	boolean	Indicates whether the custom alert rule is enabled. Valid values: true and false.	true
RemindName	string	The name of the custom alert rule.	Rule name
AlertTargets	array	The IDs of the Alibaba Cloud accounts used by alert recipients.
	string	The ID of the Alibaba Cloud account used by the alert recipient.	952795****
NodeIds	array	The IDs of the nodes to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is NODE.
	integer	The ID of the node to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is NODE.	1234
BizProcessIds	array	The IDs of the workflows to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is BIZPROCESS.
	integer	The ID of the workflow to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is BIZPROCESS.	9527
ProjectIds	array	The IDs of the workspaces to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is PROJECT.
	integer	The ID of the workspace to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is PROJECT.	1234
BaselineIds	array	The IDs of the baselines to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is BASELINE.
	integer	The ID of the baseline to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is BASELINE.	9527
AlertMethods	array	The notification method. Valid values: MAIL, SMS, and PHONE. The value MAIL indicates that the notification is sent by email. Only DataWorks Professional Edition and more advanced editions support the PHONE notification method.
	string	The notification method. Valid values: MAIL, SMS, and PHONE. The value MAIL indicates that the notification is sent by email. Only DataWorks Professional Edition and more advanced editions support the PHONE notification method.	SMS

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "RequestId": "0000-ABCD-EFG****",
  "ErrorMessage": "The specified parameters are invalid.",
  "ErrorCode": "1031203110005",
  "Success": true,
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 100,
    "Reminds": [
      {
        "Founder": "952795****",
        "RemindId": 1234,
        "AlertUnit": "OWNER",
        "RemindType": "FINISHED",
        "DndEnd": "08:00",
        "DndStart": "00:00",
        "RemindUnit": "NODE",
        "Useflag": true,
        "RemindName": "Rule name",
        "AlertTargets": [
          "952795****"
        ],
        "NodeIds": [
          1234
        ],
        "BizProcessIds": [
          9527
        ],
        "ProjectIds": [
          1234
        ],
        "BaselineIds": [
          9527
        ],
        "AlertMethods": [
          "SMS"
        ]
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
500	Forbidden.Not.Server	The dataworksAPI service is not available in this area. Please try it in another area.
500	InternalError.System	An internal system error occurred. Try again later.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.
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.System	The DataWorks system is busy. Try again later.
429	Throttling.User	Your request is too frequent. Try again later.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.