ListReminds

Queries or searches 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 Alibaba Cloud account ID of the alert rule creator.	9527952795****
NodeId	integer	No	The node ID. Use this parameter to filter alert rules by node.	1234
RemindTypes	string	No	The alert trigger conditions. Separate multiple values with commas (,). Valid values: FINISHED (node completed), UNFINISHED (node still running at the specified time), ERROR (node error), CYCLE_UNFINISHED (node not completed within the scheduling cycle), TIMEOUT (node timed out).	FINISHED,ERROR
AlertTarget	string	No	The Alibaba Cloud account ID of the alert recipient.	9527952795****
SearchText	string	No	The keyword to search for in rule names. Fuzzy match 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 request ID.	0000-ABCD-EFG****
ErrorMessage	string	The error message returned.	The specified parameters are invalid.
ErrorCode	string	The error code returned.	1031203110005
Success	boolean	Whether the request was successful.	true
Data	object	The data returned.
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries returned per page.	10
TotalCount	integer	The total number of alert rules.	100
Reminds	array<object>	The list of custom alert rules.
	object
Founder	string	The Alibaba Cloud account ID of the rule creator.	952795****
RemindId	integer	The custom alert rule ID.	1234
AlertUnit	string	The alert recipient. Valid values: OWNER (node owner) and OTHER (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 object type that the alert rule applies to. Valid values: NODE (node), BASELINE (baseline), PROJECT (workspace), BIZPROCESS (workflow).	NODE
Useflag	boolean	Whether the alert rule is enabled.	true
RemindName	string	The name of the custom alert rule.	Rule name
AlertTargets	array	The Alibaba Cloud account IDs of alert recipients.
	string	The Alibaba Cloud account ID of an alert recipient.	952795****
NodeIds	array	The node IDs that the alert rule applies to. Returned only when RemindUnit is NODE.
	integer	A node ID that the alert rule applies to. Returned only when RemindUnit is NODE.	1234
BizProcessIds	array	The workflow IDs that the alert rule applies to. Returned only when RemindUnit is BIZPROCESS.
	integer	A workflow ID that the alert rule applies to. Returned only when RemindUnit is BIZPROCESS.	9527
ProjectIds	array	The workspace IDs that the alert rule applies to. Returned only when RemindUnit is PROJECT.
	integer	A workspace ID that the alert rule applies to. Returned only when RemindUnit is PROJECT.	1234
BaselineIds	array	The baseline IDs that the alert rule applies to. Returned only when RemindUnit is BASELINE.
	integer	A baseline ID that the alert rule applies to. Returned only when RemindUnit is BASELINE.	9527
AlertMethods	array	The notification methods. Valid values: MAIL (email), SMS, PHONE (requires DataWorks Professional Edition or higher).
	string	The notification method. Valid values: MAIL (email), SMS, PHONE (requires DataWorks Professional Edition or higher).	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.