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

Queries the list of alerting rules for data integration new-version nodes. Currently supported node types include the MySQL-to-Hologres full-database real-time Solutions.

Operation description

When your task synchronization type includes real-time synchronization, you can configure 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

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 task ID. This is the task ID associated with the alert rule. You can obtain this value from DIJobPaging.DIJobs[].DIJobId in the ListDIJobs response.	11260
PageNumber	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The page size. Default value: 10.	10

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	74C2FECD-5B3A-554A-BCF5-35****
DIAlarmRulePaging	object	The paginated result of alert rules.
TotalCount	integer	The total number of records.	2
PageNumber	integer	The page number.	1
PageSize	integer	The page size.	10
DIJobAlarmRules	array<object>	The list of alert rules.
	array<object>	The alert rule.
DIAlarmRuleId	integer	The alert rule ID.	41998
DIJobId	integer	The task ID. This is the task ID associated with the alert rule.	11260
Description	string	The description.	mysql synchronizes to hologres heartbeat alert
MetricType	string	The alert metric type. Valid values: Heartbeat: task status alert. FailoverCount: failover count alert. Delay: task delay alert.	Heartbeat
Enabled	boolean	Indicates whether the alert rule is enabled.	true
TriggerConditions	array<object>	The list of alert trigger conditions. Multiple conditions are supported.
	object	The alert trigger condition.
Severity	string	The severity level. Valid values: Warning Critical	Warning
Duration	integer	The time window for alert calculation. Unit: minutes.	15
Threshold	integer	The alert threshold. Task status alert: no threshold. Failover count alert: the threshold is the number of failovers. Task delay alert: the threshold is the delay duration. Unit: seconds.	5
NotificationSettings	object	The alert notification settings.
NotificationChannels	array<object>	The alert notification channels. Multiple values are supported.
	object	The alert notification channel.
Severity	string	The severity level. Valid values: Warning Critical	Warning
Channels	array	The list of channels.
	string	The channel. Valid values: Mail: email. Phone: phone call. Sms: text message. Ding: DingTalk.	Ding
NotificationReceivers	array<object>	The alert notification receivers. Multiple values are supported.
	object	The alert notification receiver.
ReceiverType	string	The receiver type. If the alert notification channel is email, phone call, or text message, the receiver type is Alibaba Cloud user ID (AliyunUid). If the alert notification channel is DingTalk, the receiver type is DingTalk token (DingToken).	DingToken
ReceiverValues	array	The list of receiver values.
	string	The receiver value. If the receiver type is Alibaba Cloud ID, the receiver value is the specific Alibaba Cloud user ID. If the receiver type is DingTalk token, the receiver value is the specific DingTalk token value.	token1
InhibitionInterval	integer	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.