Queries custom alert rules.

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 ListReminds

The operation that you want to perform. Set the value to ListReminds.

PageNumber Integer Yes 1

The number of the page to return. Valid values: 1 to 30. Default value: 1.

PageSize Integer Yes 10

The number of entries to return on each page. Default value: 10. Maximum value: 100.

Founder String No 9527952795****

The ID of the Alibaba Cloud account that is used to create the custom alert rules.

NodeId Long No 1234

The ID of the node to which the custom alert rules are applied. The ID can be used to search for the custom alert rules that are applied to the node.

RemindTypes String No FINISHED,ERROR

The conditions that trigger an alert. Valid values: FINISHED, UNFINISHED, ERROR, CYCLE_UNFINISHED, and TIMEOUT. The value FINISHED indicates that the node is run. The value UNFINISHED indicates that the node is still running at the specified point in time. The value ERROR indicates that an error occurs when the node is running. The value CYCLE_UNFINISHED indicates that the node is still running in the specified cycle. The value TIMEOUT indicates that the node times out. You can specify multiple conditions. Separate them with commas (,).

AlertTarget String No 9527952795****

The ID of the Alibaba Cloud account used by the alert recipient.

SearchText String No Keyword

The keyword in the rule name used to search for the rule. Fuzzy search is supported.

Response parameters

Parameter Type Example Description
HttpStatusCode Integer 200

The HTTP status code returned.

RequestId String 0000-ABCD-EFG****

The ID of the request. You can use the ID to troubleshoot issues.

ErrorMessage String The specified parameters are invalid.

The error message returned.

ErrorCode String 1031203110005

The error code returned.

Success Boolean true

Indicates whether the request was successful.

Data Object

The list of returned custom alert rules.

PageNumber Integer 1

The page number of the returned page.

PageSize Integer 10

The number of entries returned per page.

TotalCount Integer 100

The total number of custom alert rules returned.

Reminds Array of Reminds

The list of custom alert rules.

Founder String 952795****

The ID of the Alibaba Cloud account that is used to create the custom alert rules.

RemindId Long 1234

The ID of the custom alert rule.

AlertUnit String OWNER

The recipient of the alert. Valid values: OWNER and OTHER. The value OWNER indicates the node owner. The value OTHER indicates a specified user.

RemindType String FINISHED

The conditions that trigger an alert. Valid values: FINISHED, UNFINISHED, ERROR, CYCLE_UNFINISHED, and TIMEOUT. The value FINISHED indicates that the node is run. The value UNFINISHED indicates that the node is still running at the specified point in time. The value ERROR indicates that an error occurs when the node is running. The value CYCLE_UNFINISHED indicates that the node is still running in the specified cycle. The value TIMEOUT indicates that the node times out.

DndEnd String 08:00

The end time of the quiet hours. Specify the time in the hh:mm format. Valid values of hh: 0 to 23. Valid values of mm: 0 to 59.

DndStart String 00:00

The start time of the quiet hours. Specify the time in the hh:mm format. Valid values of hh: 0 to 23. Valid values of mm: 0 to 59.

RemindUnit String NODE

The type of the object to which the custom alert rule is applied. Valid values: NODE, BASELINE, PROJECT, and BIZPROCESS. The value NODE indicates that the monitored object is a node. The value BASELINE indicates that the monitored object is a baseline. The value PROJECT indicates that the monitored object is a workspace. The value BIZPROCESS indicates that the monitored object is a workflow.

Useflag Boolean true

Indicates whether the custom alert rule is enabled. Valid values: true and false.

RemindName String Rule name

The name of the custom alert rule.

AlertTargets Array of String 952795****

The IDs of the Alibaba Cloud account used by the alert recipient.

NodeIds Array of Long 1234

The IDs of the nodes to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is NODE.

BizProcessIds Array of Long 9527

The IDs of the workflows to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is BIZPROCESS.

ProjectIds Array of Long 1234

The IDs of the workspaces to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is PROJECT.

BaselineIds Array of Long 9527

The IDs of the baselines to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is BASELINE.

AlertMethods Array of String SMS

The notification method. Valid values: MAIL, SMS, and PHONE. The value MAIL indicates that the notification is sent by email. The value SMS indicates that the notification is sent by text message. The value PHONE indicates that the notification is sent by call, which is supported only by DataWorks Professional Edition and more advanced editions.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListReminds
&PageNumber=1
&PageSize=10
&Founder=9527952795****
&NodeId=1234
&RemindTypes=FINISHED,ERROR
&AlertTarget=9527952795****
&SearchText=Keyword
&<Common request parameters>

Sample success responses

XML format

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

<ListRemindsResponse>
    <HttpStatusCode>200</HttpStatusCode>
    <RequestId>0000-ABCD-EFG****</RequestId>
    <ErrorMessage>The specified parameters are invalid.</ErrorMessage>
    <ErrorCode>1031203110005</ErrorCode>
    <Success>true</Success>
    <Data>
        <PageNumber>1</PageNumber>
        <PageSize>10</PageSize>
        <TotalCount>100</TotalCount>
        <Reminds>
            <Founder>952795****</Founder>
            <RemindId>1234</RemindId>
            <AlertUnit>OWNER</AlertUnit>
            <RemindType>FINISHED</RemindType>
            <DndEnd>08:00</DndEnd>
            <DndStart>00:00</DndStart>
            <RemindUnit>NODE</RemindUnit>
            <Useflag>true</Useflag>
            <RemindName>Rule name</RemindName>
            <AlertTargets>952795****</AlertTargets>
            <NodeIds>1234</NodeIds>
            <BizProcessIds>9527</BizProcessIds>
            <ProjectIds>1234</ProjectIds>
            <BaselineIds>9527</BaselineIds>
            <AlertMethods>SMS</AlertMethods>
        </Reminds>
    </Data>
</ListRemindsResponse>

JSON format

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

{
  "HttpStatusCode" : 200,
  "RequestId" : "0000-ABCD-EFG****",
  "ErrorMessage" : "The specified parameters are invalid.",
  "ErrorCode" : 1031203110005,
  "Success" : true,
  "Data" : {
    "PageNumber" : 1,
    "PageSize" : 10,
    "TotalCount" : 100,
    "Reminds" : {
      "Founder" : "952795****",
      "RemindId" : 1234,
      "AlertUnit" : "OWNER",
      "RemindType" : "FINISHED",
      "DndEnd" : "08:00",
      "DndStart" : "00:00",
      "RemindUnit" : "NODE",
      "Useflag" : true,
      "RemindName": "Rule name",
      "AlertTargets" : "952795****",
      "NodeIds" : 1234,
      "BizProcessIds" : 9527,
      "ProjectIds" : 1234,
      "BaselineIds" : 9527,
      "AlertMethods" : "SMS"
    }
  }
}

Error codes

HTTP status code Error code Error message Description
429 Throttling.Api The request for this resource has exceeded your available limit. The error message returned because the number of requests for the resource has exceeded the upper limit.
429 Throttling.Api.Risk The request for this resource has exceeded your daily available limit. The error message returned because the number of requests per day for the resource has exceeded the upper limit.
429 Throttling.System The DataWorks system is busy. Try again later. The error message returned because the DataWorks system is busy. Try again later.
429 Throttling.User Your request is too frequent. Try again later. The error message returned because excessive requests have been submitted within a short period of time. Try again later.
500 Forbidden.Not.Server The dataworksAPI service is not available in this area. Please try it in another area. The error message returned because the DataWorks API is unavailable in this region. Try another region.
500 InternalError.System An internal system error occurred. Try again later. The error message returned because an internal error has occurred. Try again later.
500 InternalError.UserId.Missing An internal system error occurred. Try again later. The error message returned because an internal error has occurred. Try again later.

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