ListDIAlarmRules API for Sync Task Alert Monitoring - DataWorks - Alibaba Cloud - DataWorks

Retrieves a list of alert rules configured for a synchronization task.

Operation description

Alert rules can be configured when your task includes real-time synchronization.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dataworks:*

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DIJobId	integer	Yes	The ID of the task with which the alert rules are associated.	11260
PageNumber	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 10.	10

Response elements

Element	Type	Description	Example
	object	The returned result.
RequestId	string	The request ID.	74C2FECD-5B3A-554A-BCF5-35****
DIAlarmRulePaging	object	The pagination information.
TotalCount	integer	The total number of entries returned.	2
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
DIJobAlarmRules	array<object>	The alert rules.
	array<object>	The details of the alert rule.
DIAlarmRuleId	integer	The alert rule ID.	41998
DIJobId	integer	The ID of the task with which the alert rule is associated.	11260
Description	string	The description of the alert rule.	mysql synchronizes to hologres heartbeat alert
MetricType	string	The metric type in the alert rule. Valid values: Heartbeat FailoverCount Delay	Heartbeat
Enabled	boolean	Indicates whether the alert rule is enabled.	true
TriggerConditions	array<object>	The conditions that are used to trigger the alert rule.
	object	The condition that is used to trigger the alert rule.
Severity	string	The severity level. Valid values: Warning Critical	Warning
Duration	integer	The time interval for alert calculation. Unit: minutes.	15
Threshold	integer	The alert threshold. If the alert rule is for task status, no threshold is used. If the alert rule is for failovers, the threshold is the number of failovers. If the alert rule is for latency, the threshold is the latency duration, in seconds.	5
NotificationSettings	object	The alert notification settings.
NotificationChannels	array<object>	The alert notification methods.
	object	The alert notification method.
Severity	string	The severity level. Valid values: Warning Critical	Warning
Channels	array	The alert notification methods.
	string	The alert notification method. Valid values: Mail: email Phone: phone call Sms: text message Ding: DingTalk chatbot token	Ding
NotificationReceivers	array<object>	The settings of alert notification recipients.
	object	The setting of an alert notification recipient.
ReceiverType	string	The recipient type. Valid values: AliyunUid and DingToken. If the alert notification method is Mail, Phone, or Sms, the value of this parameter is AliyunUid, which indicates the Alibaba Cloud account ID. If the alert notification method is Ding, the value of this parameter is DingToken, which indicates the DingTalk chatbot token.	DingToken
ReceiverValues	array	The recipients.
	string	The recipient. If the recipient type is Alibaba Cloud account ID, the value of this parameter is the Alibaba Cloud account ID of a user. If the recipient type is DingTalk chatbot token, the value of this parameter is the token of a DingTalk chatbot.	token1
InhibitionInterval	integer	The duration of the alert suppression interval. Unit: minutes.	5

Examples

Success response

JSON format

{
  "RequestId": "74C2FECD-5B3A-554A-BCF5-35****",
  "DIAlarmRulePaging": {
    "TotalCount": 2,
    "PageNumber": 1,
    "PageSize": 10,
    "DIJobAlarmRules": [
      {
        "DIAlarmRuleId": 41998,
        "DIJobId": 11260,
        "Description": "mysql synchronizes to hologres heartbeat alert",
        "MetricType": "Heartbeat",
        "Enabled": true,
        "TriggerConditions": [
          {
            "Severity": "Warning",
            "Duration": 15,
            "Threshold": 5
          }
        ],
        "NotificationSettings": {
          "NotificationChannels": [
            {
              "Severity": "Warning",
              "Channels": [
                "Ding"
              ]
            }
          ],
          "NotificationReceivers": [
            {
              "ReceiverType": "DingToken",
              "ReceiverValues": [
                "token1"
              ]
            }
          ],
          "InhibitionInterval": 5
        }
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
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.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.