GetRemind - DataWorks - Alibaba Cloud Documentation Center

Queries the information about a custom alert rule.

Operation description

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
RemindId	long	Yes	The custom alert rule ID.	1234

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
HttpStatusCode	integer	The HTTP status code.	200
RequestId	string	The request ID.	0000-ABCD-EFGH-IJKLMNOPQ
ErrorMessage	string	The error message.	The specified parameters are invalid.
ErrorCode	string	The error code.	1031203110005
Success	boolean	Indicates whether the request was successful.	true
Data	object	The details of the custom alert rule.
MaxAlertTimes	integer	The maximum number of alerts.	3
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
AlertInterval	integer	The minimum interval at which alerts are reported. Unit: seconds.	1800
Useflag	boolean	Indicates whether the custom alert rule is enabled. Valid values: true and false.	true
Founder	string	The ID of the Alibaba Cloud account used by the creator of the custom alert rule.	9527951795****
RemindId	long	The custom alert rule ID.	1234
DndEnd	string	The end time of the quiet hours. The value is in the hh:mm format. Valid values of hh: [0,23]. Valid values of mm: [0,59].	08:00
RemindType	string	The conditions that trigger an alert. Valid values: FINISHED, UNFINISHED, ERROR, CYCLE_UNFINISHED, and TIMEOUT.	FINISHED
AlertUnit	string	The type of the alert recipient. For more information about alert recipient types, see the Receivers parameter. Valid values: OWNER: the task owner OTHER: specified personnel SHIFT_SCHEDULE: personnel in a shift schedule	OWNER
DndStart	string	The start time of the quiet hours. The value is in the hh:mm format. Valid values of hh: [0,23]. Valid values of mm: [0,59].	00:00
RemindName	string	The name of the rule.	Rule name
Detail	string	If the value of the RemindType parameter is FINISHED, this parameter is left empty. If the value of the RemindType parameter is UNFINISHED, the trigger conditions are returned as key-value pairs. Example: {"hour":23,"minu":59}. Valid values of hour: [0,47]. Valid values of minu: [0,59]. If the value of the RemindType parameter is ERROR, this parameter is left empty. If the value of the RemindType parameter is CYCLE_UNFINISHED, the trigger conditions are returned as key-value pairs. Example: {"1":"05:50","2":"06:50","3":"07:50","4":"08:50","5":"09:50","6":"10:50","7":"11:50","8":"12:50","9":"13:50","10":"14:50","11":"15:50","12":"16:50","13":"17:50","14":"18:50","15":"19:50","16":"20:50","17":"21:50","18":"22:50","19":"23:50","20":"24:50","21":"25:50"}. The key indicates the ID of the cycle. Valid values: [1,288]. The value indicates the timeout period of the node that is running in the cycle. Specify the value in the hh:mm format. Valid values of hh: [0,47]. Valid values of mm: [0,59]. If the value of the RemindType parameter is TIMEOUT, the timeout period is returned. Unit: seconds. Example: 1800. This value indicates that an alert is reported if the node has run for more than 30 minutes.	{"hour":23,"minu":59}
Robots	array<object>	The webhook URLs of the DingTalk chatbots.
Robots	object
WebUrl	string	The webhook URL of the DingTalk chatbot.	https://oapi.dingtalk.com/robot/send?access_token=******************************
AtAll	boolean	Indicates whether all group members are notified when the alert notification is sent to a DingTalk group. Valid values: true and false.	true
Nodes	array<object>	The nodes to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is NODE.
Nodes	object
Owner	string	The ID of the Alibaba Cloud account used by the node owner.	9527951795****
NodeName	string	The name of the node.	Node name
NodeId	long	The node ID.	1234
ProjectId	long	The ID of the workspace to which the node belongs.	1234
Baselines	array<object>	The baselines to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is BASELINE.
Baselines	object
BaselineName	string	The name of the baseline.	Baseline name
BaselineId	long	The baseline ID.	1234
Projects	array<object>	The workspaces to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is PROJECT.
Projects	object
ProjectId	long	The workspace ID.	1234
BizProcesses	array<object>	The workflows to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is BIZPROCESS.
BizProcesses	object
BizProcessName	string	The name of the workflow.	Business process name
BizId	long	The ID of the workflow.	9527
AlertTargets	array	The description of the alert recipient. For more information about alert recipients, see the Receivers parameter.
AlertTargets	string	If the value of the AlertUnit parameter is OWNER, this parameter is left empty. If the value of the AlertUnit parameter is OTHER, the ID of the Alibaba Cloud account used by the specified user is returned. If the value of the AlertUnit parameter is SHIFT_SCHEDULE, the shift schedule ID is returned.	9527952795279527
AlertMethods	array	The notification method.
AlertMethods	string	The notification method. Valid values: MAIL SMS Alert notifications can be sent by text message only in the Singapore, Malaysia (Kuala Lumpur), and Germany (Frankfurt) regions.	SMS,MAIL
Webhooks	array	WebHook URL
Webhooks	string	The webhook URL of the WeCom or Lark chatbot. You must specify Webhooks for AlertMethods. Only DataWorks Enterprise Edition supports this parameter.	https://open.feishu.cn/open-apis/bot/v2/hook/*******
Receivers	array<object>	The information about the alert recipients.
Receivers	object	The information about the alert recipient.
AlertUnit	string	The type of the alert recipient. For more information about alert recipients, see the Receivers parameter. Valid values: OWNER: indicate the task owner. OTHER: indicates specified personnel. SHIFT_SCHEDULE: indicates personnel in a shift schedule.	OWNER
AlertTargets	array	The alert recipient.
AlertTargets	string	If the value of the AlertUnit parameter is OWNER, this parameter is left empty. If the value of the AlertUnit parameter is OTHER, the ID of the Alibaba Cloud account used by the specified user is returned. If the value of the AlertUnit parameter is SHIFT_SCHEDULE, the shift schedule ID is returned.	9527952795279527
AllowNodes	array	The IDs of the nodes that are added to a whitelist.
allowNodes	long	The ID of the node that is added to a whitelist. The nodes that you add to the whitelist are not monitored.	123

Examples

Sample success responses

JSONformat

{
  "HttpStatusCode": 200,
  "RequestId": "0000-ABCD-EFGH-IJKLMNOPQ",
  "ErrorMessage": "The specified parameters are invalid.",
  "ErrorCode": 1031203110005,
  "Success": true,
  "Data": {
    "MaxAlertTimes": 3,
    "RemindUnit": "NODE",
    "AlertInterval": 1800,
    "Useflag": true,
    "Founder": "9527951795****",
    "RemindId": 1234,
    "DndEnd": "08:00",
    "RemindType": "FINISHED",
    "AlertUnit": "OWNER",
    "DndStart": "00:00",
    "RemindName": "Rule name",
    "Detail": {
      "hour": 23,
      "minu": 59
    },
    "Robots": [
      {
        "WebUrl": "https://oapi.dingtalk.com/robot/send?access_token=******************************",
        "AtAll": true
      }
    ],
    "Nodes": [
      {
        "Owner": "9527951795****",
        "NodeName": "Node name",
        "NodeId": 1234,
        "ProjectId": 1234
      }
    ],
    "Baselines": [
      {
        "BaselineName": "Baseline name",
        "BaselineId": 1234
      }
    ],
    "Projects": [
      {
        "ProjectId": 1234
      }
    ],
    "BizProcesses": [
      {
        "BizProcessName": "Business process name",
        "BizId": 9527
      }
    ],
    "AlertTargets": [
      9527952795279528
    ],
    "AlertMethods": [
      "SMS,MAIL"
    ],
    "Webhooks": [
      "https://open.feishu.cn/open-apis/bot/v2/hook/*******"
    ],
    "Receivers": [
      {
        "AlertUnit": "OWNER",
        "AlertTargets": [
          9527952795279528
        ]
      }
    ],
    "AllowNodes": [
      123
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
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.Resource	You have reached the limit for the resource. Please contact us by submitting a ticket.	-
429	Throttling.System	The DataWorks system is busy. Try again later.	-
429	Throttling.User	Your request is too frequent. Try again later.	-
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.	-

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-09-18	The Error code has changed. The response structure of the API has changed	View Change Details