ListDIAlarmRules - DataWorks - Alibaba Cloud Documentation Center

You can configure alert rules only for tasks whose MigrationType is set to RealtimeIncremental.

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.

Request parameters

Parameter	Type	Required	Example	Description
Action	String	Yes	ListDIAlarmRules	The operation that you want to perform. Set the value to ListDIAlarmRules.
DIJobId	Long	Yes	11260	The ID of the task with which the alert rules are associated.
PageNumber	Long	No	1	The page number. Default value: 1.
PageSize	Long	No	10	The number of entries per page. Default value: 10.

Response parameters

Parameter	Type	Example	Description
RequestId	String	74C2FECD-5B3A-554A-BCF5-351A36DE9815	The request ID.
DIAlarmRulePaging	Object		The pagination data.
TotalCount	Long	2	The total number of entries returned.
PageNumber	Long	1	The page number.
PageSize	Long	10	The number of entries per page.
DIJobAlarmRules	Array of DIJobAlarmRule		The alert rules.
DIAlarmRuleId	Long	41998	The alert rule ID.
DIJobId	Long	11260	The ID of the task with which the alert rule is associated.
Description	String	Alert rule for heartbeat of data synchronization from MySQL to Hologres	The description of the alert rule.
MetricType	String	Heartbeat	The metric type in the alert rule.
Enabled	Boolean	true	Indicates whether the alert rule is enabled.
TriggerConditions	Array of TriggerCondition		The conditions that can trigger the alert rule.
Severity	String	Warning	The severity level.
Duration	Long	15	The time interval for alert calculation. Unit: minutes.
Threshold	Long	5	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.
NotificationSettings	Object		The alert notification settings.
NotificationChannels	Array of NotificationChannel		The alert notification methods.
Severity	String	Warning	The severity level.
Channels	Array of String	Ding	The method.
NotificationReceivers	Array of NotificationReceiver		The alert notification recipients.
ReceiverType	String	DingToken	The recipient type. If the alert notification method is Mail, Phone, or Sms, the recipient type is Alibaba Cloud account ID. If the alert notification method is Ding, the recipient type is DingTalk chatbot token.
ReceiverValues	Array of String	token1	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.
InhibitionInterval	Integer	5	The duration of the alert suppression interval. Unit: minutes.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListDIAlarmRules
&DIJobId=11260
&PageNumber=1
&PageSize=10
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<ListDIAlarmRulesResponse>
    <RequestId>74C2FECD-5B3A-554A-BCF5-351A36DE9815</RequestId>
    <DIAlarmRulePaging>
        <TotalCount>2</TotalCount>
        <PageNumber>1</PageNumber>
        <PageSize>10</PageSize>
        <DIJobAlarmRules>
            <DIAlarmRuleId>41998</DIAlarmRuleId>
            <DIJobId>11260</DIJobId>
            <Description>Alert rule for heartbeat of data synchronization from MySQL to Hologres</Description>
            <MetricType>Heartbeat</MetricType>
            <Enabled>true</Enabled>
            <TriggerConditions>
                <Severity>Warning</Severity>
                <Duration>15</Duration>
                <Threshold>5</Threshold>
            </TriggerConditions>
            <NotificationSettings>
                <NotificationChannels>
                    <Severity>Warning</Severity>
                    <Channels>Ding</Channels>
                </NotificationChannels>
                <NotificationReceivers>
                    <ReceiverType>DingToken</ReceiverType>
                    <ReceiverValues>token1</ReceiverValues>
                </NotificationReceivers>
                <InhibitionInterval>5</InhibitionInterval>
            </NotificationSettings>
        </DIJobAlarmRules>
    </DIAlarmRulePaging>
</ListDIAlarmRulesResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "74C2FECD-5B3A-554A-BCF5-351A36DE9815",
  "DIAlarmRulePaging" : {
    "TotalCount" : 2,
    "PageNumber" : 1,
    "PageSize" : 10,
    "DIJobAlarmRules" : [ {
      "DIAlarmRuleId" : 41998,
      "DIJobId" : 11260,
      "Description" : "Alert rule for heartbeat of data synchronization from MySQL to Hologres",
      "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
429	Throttling.Api	The request for this resource has exceeded your available limit.	The number of requests for the resource has exceeded the upper limit.
429	Throttling.System	The DataWorks system is busy. Try again later.	The DataWorks system is busy. Try again later.
429	Throttling.User	Your request is too frequent. Try again later.	Excessive requests have been submitted within a short period of time. Try again later.
500	InternalError.System	An internal system error occurred. Try again later.	An internal error has occurred. Try again later.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.	An internal error has occurred. Try again later.

For a list of error codes, see Service error codes.