GetAlertMessage-DataWorks(DataWorks)-阿里云帮助中心

Queries alert information based on the alert ID that is specified by the AlertId parameter.

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
AlertId	string	Yes	The alert ID. You can call the ListAlertMessages operation to obtain the alert ID.	1421

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	0000-ABCD-EFG****
HttpStatusCode	integer	The HTTP status code.	200
ErrorMessage	string	The error message.	The specified parameters are invalid.
ErrorCode	string	The error code.	Invalid.Tenant.ConnectionNotExists
Success	boolean	Indicates whether the request was successful. Valid values: true: successful false: failed	true
Data	object	The information about returned alerts.
RemindId	integer	The ID of the custom alert rule that was triggered. This parameter is returned if the value of the Source parameter is REMIND_ALERT.	1234
AlertMessageStatus	string	The sending status of the notification. Valid values: READY_TO_SEND: The notification is waiting to be sent. SEND_FAIL: The notification fails to be sent. SEND_SUCCESS: The notification is sent. SEND_OVERLIMIT: The number of notifications that are sent exceeds the upper limit.	READY_TO_SEND
AlertUser	string	The ID of the Alibaba Cloud account used by the alert recipient.	9527952795****
AlertTime	integer	The time when the alert was reported.	1553524393000
AlertMethod	string	The notification method. Valid values: MAIL (email). SMS (text message). PHONE (phone call). Only DataWorks Professional Edition and more advanced editions support the PHONE notification method.	SMS
Source	string	The type of the alert. Valid values: REMIND_ALERT: The alert is a custom alert. TOPIC_ALERT: The alert is an event alert. SLA_ALERT: The alert is a baseline alert. NODE_CYCLE_ALERT: The alert is reported for a node dependency loop. NODE_LONELY_ALERT: The alert is reported for isolated nodes.	REMIND_ALERT
Content	string	The content of the alert.	Node error
RemindName	string	The name of the custom alert rule that was triggered. This parameter is returned if the value of the Source parameter is REMIND_ALERT.	Custom monitoring rule name
AlertId	integer	The alert ID.	123
Instances	array<object>	The instances that triggered the custom alert rule. This parameter is returned if the value of the Source parameter is REMIND_ALERT. This parameter is left empty if the value of the Source parameter is not REMIND_ALERT.
	object	The information about the instance.
Status	string	The status of the instance. Valid values: NOT_RUN: not run WAIT_TIME: waiting for the scheduled time WAIT_RESOURCE: waiting for resources RUNNING: running CHECKING: validating CHECKING_CONDITION: checking conditions FAILURE: failed SUCCESS: successful	NOT_RUN
InstanceId	integer	The instance ID.	12312****
NodeName	string	The name of the node.	Node name
NodeId	integer	The node ID.	1234
ProjectId	integer	The ID of the workspace to which the node belongs.	1234
Topics	array<object>	The events that triggered alerts. This parameter is returned if the value of the Source parameter is TOPIC_ALERT. This parameter is left empty if the value of the Source parameter is not TOPIC_ALERT.
	object	The information about the event.
TopicName	string	The name of the event.	error
InstanceId	integer	The ID of the instance associated with the event.	12345
TopicId	integer	The event ID.	412431
TopicOwner	string	The ID of the Alibaba Cloud account used by the event owner.	9527952795****
NodeId	integer	The ID of the node associated with the event.	1234
TopicStatus	string	The status of the event. Valid values: IGNORE: ignored NEW: newly discovered FIXING: being handled RECOVER: recovered	FIXING
Nodes	array<object>	The nodes returned for different alert sources. The nodes that form a loop are returned if the value of the Source parameter is NODE_CYCLE_ALERT. The nodes that are isolated are returned if the value of the Source parameter is NODE_LONELY_ALERT.
	object	The information about the node.
Owner	string	The ID of the Alibaba Cloud account used by the node owner.	95279527952****
NodeName	string	The name of the node.	Node name
NodeId	integer	The node ID.	1234
ProjectId	integer	The ID of the workspace to which the node belongs.	1234
SlaAlert	object	The basic information about the baseline instance that triggered an alert. This parameter is returned if the value of the Source parameter is SLA_ALERT. This parameter is left empty if the value of the Source parameter is not SLA_ALERT.
Status	string	The status of the baseline. Valid values: ERROR: abnormal SAFE: safe DANGEROUS: warning OVER: breached	SAFE
BaselineOwner	string	The ID of the Alibaba Cloud account used by the baseline owner. Multiple IDs are separated by commas (,).	952795279****
BaselineId	integer	The baseline ID.	15142123
BaselineName	string	The name of the baseline.	Baseline name
Bizdate	integer	The business date timestamp of the baseline instance.	1553443200000
ProjectId	integer	The ID of the workspace to which the baseline belongs.	1234
InGroupId	integer	The ID of the cycle of the baseline instance. Valid values of the ID of an hour-level cycle: [1,24]. The ID of a day-level cycle is 1.	1

Examples

Success response

JSON format

{
  "RequestId": "0000-ABCD-EFG****",
  "HttpStatusCode": 200,
  "ErrorMessage": "The specified parameters are invalid.",
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Success": true,
  "Data": {
    "RemindId": 1234,
    "AlertMessageStatus": "READY_TO_SEND",
    "AlertUser": "9527952795****",
    "AlertTime": 1553524393000,
    "AlertMethod": "SMS",
    "Source": "REMIND_ALERT",
    "Content": "Node error",
    "RemindName": "Custom monitoring rule name",
    "AlertId": 123,
    "Instances": [
      {
        "Status": "NOT_RUN",
        "InstanceId": 0,
        "NodeName": "Node name",
        "NodeId": 1234,
        "ProjectId": 1234
      }
    ],
    "Topics": [
      {
        "TopicName": "error",
        "InstanceId": 12345,
        "TopicId": 412431,
        "TopicOwner": "9527952795****",
        "NodeId": 1234,
        "TopicStatus": "FIXING"
      }
    ],
    "Nodes": [
      {
        "Owner": "95279527952****",
        "NodeName": "Node name",
        "NodeId": 1234,
        "ProjectId": 1234
      }
    ],
    "SlaAlert": {
      "Status": "SAFE",
      "BaselineOwner": "952795279****",
      "BaselineId": 15142123,
      "BaselineName": "Baseline name",
      "Bizdate": 1553443200000,
      "ProjectId": 1234,
      "InGroupId": 1
    }
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.