Queries the details of a custom alert rule.

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 GetRemind

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

RegionId String Yes cn-shanghai

The ID of the region.

RemindId Long Yes 1234

The ID of the custom alert rule.

Response parameters

Parameter Type Example Description
HttpStatusCode Integer 200

The HTTP status code returned.

RequestId String 0000-ABCD-EFGH-IJKLMNOPQ

The unique ID of the request. You can troubleshoot issues based on the ID.

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 is successful.

Data Object

The details of the custom alert rule.

MaxAlertTimes Integer 3

The maximum number of alerts.

RemindUnit String NODE

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

AlertInterval Integer 1800

The minimum interval at which alerts are reported. Unit: seconds.

Useflag Boolean true

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

Founder String 9527951795****

The ID of the Alibaba Cloud account used by the creator of the custom alert rule.

RemindId Long 1234

The ID of the custom alert rule.

DndEnd String 08:00

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

RemindType String FINISHED

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

AlertUnit String OWNER

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

DndStart String 00:00

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

RemindName String Rule name

The name of the custom alert rule.

Detail String null
  • If the value of the RemindType parameter is FINISHED, this parameter is left empty.
  • If the value of the RemindType parameter is UNFINISHED, the trigger conditions are returned as key-value pairs. Example: {"hour":23,"minu":59}. Valid values of hour: 0 to 47. Valid values of minu: 0 to 59.
  • If the value of the RemindType parameter is ERROR, this parameter is left empty.
  • If the value of the RemindType parameter is CYCLE_UNFINISHED, the trigger conditions are returned as key-value pairs. Example: {"1":"05:50","2":"06:50","3":"07:50","4":"08:50","5":"09:50","6":"10:50","7":"11:50","8":"12:50","9":"13:50","10":"14:50","11":"15:50","12":"16:50","13":"17:50","14":"18:50","15":"19:50","16":"20:50","17":"21:50","18":"22:50","19":"23:50","20":"24:50","21":"25:50"}. The key indicates the ID of the cycle. Valid values: 1 to 288. The value indicates the timeout period of the node that is run in the cycle. The value is in the hh:mm format. Valid values of hh: 0 to 47. Valid values of mm: 0 to 59.
  • If the value of the RemindType parameter is TIMEOUT, the timeout period is returned. Unit: seconds. Example: 1800. This value indicates that an alert is reported if the node is run for more than 30 minutes.
Robots Array of Robots

The webhook URLs of the DingTalk chatbots.

WebUrl String https://oapi.dingtalk.com/robot/send?access_token=******************************

The webhook URL of the DingTalk chatbot.

AtAll Boolean true

Indicates whether all group members are notified when the alert notification is sent to a DingTalk group. Valid values: true and false.

Nodes Array of Nodes

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

Owner String 9527951795****

The ID of the Alibaba Cloud account used by the owner of the node.

NodeName String Node name

The name of the node.

NodeId Long 1234

The ID of the node.

ProjectId Long 1234

The ID of the workspace to which the node belongs.

Baselines Array of Baselines

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

BaselineName String Baseline name

The name of the baseline.

BaselineId Long 1234

The ID of the baseline.

Projects Array of Projects

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

ProjectId Long 1234

The ID of the workspace.

BizProcesses Array of BizProcesses

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

BizProcessName String Workflow name

The name of the workflow.

BizId Long 9527

The ID of the workflow.

AlertTargets Array of String 9527952795279527
  • If the value of the AlertUnit parameter is OWNER, this parameter is left empty.
  • If the value of the AlertUnit parameter is OTHER, the ID of the Alibaba Cloud account used by the specified user is returned. Multiple IDs are separated by commas (,).
AlertMethods Array of String SMS,MAIL

The notification method. Valid values:

  • MAIL: Alert notifications are sent by emails.
  • SMS: Alert notifications are sent by text messages.

    Alert notifications can be sent by text messages only in the Singapore (Singapore), Malaysia (Kuala Lumpur), and Germany (Frankfurt) regions. If you want to use this notification method in other regions, submit a ticket for technical support from DataWorks.

  • Multiple notification methods are separated by commas (,).

Examples

Sample requests

http(s)://[Endpoint]/?Action=GetRemind
&RegionId=cn-shanghai
&RemindId=1234
&<Common request parameters>

Sample success responses

XML format

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

<RequestId>0000-ABCD-EFG****</RequestId>
<HttpStatusCode>200</HttpStatusCode>
<Data>
    <AlertInterval>1800</AlertInterval>
    <DndStart>00:00</DndStart>
    <BizProcesses>
        <AtAll>true</AtAll>
        <WebUrl>https://oapi.dingtalk.com/robot/send?access_token=******************************</WebUrl>
    </BizProcesses>
    <BizProcesses>
        <Owner>9527951795****</Owner>
        <NodeName>Node name</NodeName>
        <NodeId>1234</NodeId>
        <ProjectId>1234</ProjectId>
    </BizProcesses>
    <BizProcesses>
        <BaselineId>1234</BaselineId>
        <BaselineName>Baseline name</BaselineName>
    </BizProcesses>
    <BizProcesses>
        <ProjectId>1234</ProjectId>
    </BizProcesses>
    <BizProcesses>
        <BizProcessName>Workflow name</BizProcessName>
        <BizId>1234</BizId>
    </BizProcesses>
    <DndEnd>08:00</DndEnd>
    <AlertUnit>OWNER</AlertUnit>
    <AlertMethods>SMS,MAIL</AlertMethods>
    <Projects>
        <AtAll>true</AtAll>
        <WebUrl>https://oapi.dingtalk.com/robot/send?access_token=******************************</WebUrl>
    </Projects>
    <Projects>
        <Owner>9527951795****</Owner>
        <NodeName>Node name</NodeName>
        <NodeId>1234</NodeId>
        <ProjectId>1234</ProjectId>
    </Projects>
    <Projects>
        <BaselineId>1234</BaselineId>
        <BaselineName>Baseline name</BaselineName>
    </Projects>
    <Projects>
        <ProjectId>1234</ProjectId>
    </Projects>
    <Projects>
        <BizProcessName>Workflow name</BizProcessName>
        <BizId>1234</BizId>
    </Projects>
    <RemindType>FINISHED</RemindType>
    <Founder>9527951795****</Founder>
    <Nodes>
        <AtAll>true</AtAll>
        <WebUrl>https://oapi.dingtalk.com/robot/send?access_token=******************************</WebUrl>
    </Nodes>
    <Nodes>
        <Owner>9527951795****</Owner>
        <NodeName>Node name</NodeName>
        <NodeId>1234</NodeId>
        <ProjectId>1234</ProjectId>
    </Nodes>
    <Nodes>
        <BaselineId>1234</BaselineId>
        <BaselineName>Baseline name</BaselineName>
    </Nodes>
    <Nodes>
        <ProjectId>1234</ProjectId>
    </Nodes>
    <Nodes>
        <BizProcessName>Workflow name</BizProcessName>
        <BizId>1234</BizId>
    </Nodes>
    <Baselines>
        <AtAll>true</AtAll>
        <WebUrl>https://oapi.dingtalk.com/robot/send?access_token=******************************</WebUrl>
    </Baselines>
    <Baselines>
        <Owner>9527951795****</Owner>
        <NodeName>Node name</NodeName>
        <NodeId>1234</NodeId>
        <ProjectId>1234</ProjectId>
    </Baselines>
    <Baselines>
        <BaselineId>1234</BaselineId>
        <BaselineName>Baseline name</BaselineName>
    </Baselines>
    <Baselines>
        <ProjectId>1234</ProjectId>
    </Baselines>
    <Baselines>
        <BizProcessName>Workflow name</BizProcessName>
        <BizId>1234</BizId>
    </Baselines>
    <RemindId>1234</RemindId>
    <RemindUnit>NODE</RemindUnit>
    <AlertTargets>9527952795279528</AlertTargets>
    <Useflag>true</Useflag>
    <Detail>{"hour":23,"minu":59}</Detail>
    <Robots>
        <AtAll>true</AtAll>
        <WebUrl>https://oapi.dingtalk.com/robot/send?access_token=******************************</WebUrl>
    </Robots>
    <Robots>
        <Owner>9527951795****</Owner>
        <NodeName>Node name</NodeName>
        <NodeId>1234</NodeId>
        <ProjectId>1234</ProjectId>
    </Robots>
    <Robots>
        <BaselineId>1234</BaselineId>
        <BaselineName>Baseline name</BaselineName>
    </Robots>
    <Robots>
        <ProjectId>1234</ProjectId>
    </Robots>
    <Robots>
        <BizProcessName>Workflow name</BizProcessName>
        <BizId>1234</BizId>
    </Robots>
    <RemindName>Rule name</RemindName>
    <MaxAlertTimes>3</MaxAlertTimes>
</Data>
<ErrorCode>1031203110005</ErrorCode>
<ErrorMessage>The specified parameters are invalid.</ErrorMessage>
<Success>true</Success>

JSON format

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

{
  "RequestId" : "0000-ABCD-EFG****",
  "HttpStatusCode" : 200,
  "Data" : {
    "AlertInterval" : 1800,
    "DndStart" : "00:00",
    "BizProcesses" : [ {
      "AtAll" : true,
      "WebUrl" : "https://oapi.dingtalk.com/robot/send?access_token=******************************"
    }, {
      "Owner" : "9527951795****",
      "NodeName": "Node name",
      "NodeId" : 1234,
      "ProjectId" : 1234
    }, {
      "BaselineId" : 1234,
      "BaselineName": "Baseline name"
    }, {
      "ProjectId" : 1234
    }, {
      "BizProcessName": "Workflow name",
      "BizId" : 1234
    } ],
    "DndEnd" : "08:00",
    "AlertUnit" : "OWNER",
    "AlertMethods" : "SMS,MAIL",
    "Projects" : [ {
      "AtAll" : true,
      "WebUrl" : "https://oapi.dingtalk.com/robot/send?access_token=******************************"
    }, {
      "Owner" : "9527951795****",
      "NodeName": "Node name",
      "NodeId" : 1234,
      "ProjectId" : 1234
    }, {
      "BaselineId" : 1234,
      "BaselineName": "Baseline name"
    }, {
      "ProjectId" : 1234
    }, {
      "BizProcessName": "Workflow name",
      "BizId" : 1234
    } ],
    "RemindType" : "FINISHED",
    "Founder" : "9527951795****",
    "Nodes" : [ {
      "AtAll" : true,
      "WebUrl" : "https://oapi.dingtalk.com/robot/send?access_token=******************************"
    }, {
      "Owner" : "9527951795****",
      "NodeName": "Node name",
      "NodeId" : 1234,
      "ProjectId" : 1234
    }, {
      "BaselineId" : 1234,
      "BaselineName": "Baseline name"
    }, {
      "ProjectId" : 1234
    }, {
      "BizProcessName": "Workflow name",
      "BizId" : 1234
    } ],
    "Baselines" : [ {
      "AtAll" : true,
      "WebUrl" : "https://oapi.dingtalk.com/robot/send?access_token=******************************"
    }, {
      "Owner" : "9527951795****",
      "NodeName": "Node name",
      "NodeId" : 1234,
      "ProjectId" : 1234
    }, {
      "BaselineId" : 1234,
      "BaselineName": "Baseline name"
    }, {
      "ProjectId" : 1234
    }, {
      "BizProcessName": "Workflow name",
      "BizId" : 1234
    } ],
    "RemindId" : 1234,
    "RemindUnit" : "NODE",
    "AlertTargets" : 9527952795279528,
    "Useflag" : true,
    "Detail" : "{\"hour\":23,\"minu\":59}",
    "Robots" : [ {
      "AtAll" : true,
      "WebUrl" : "https://oapi.dingtalk.com/robot/send?access_token=******************************"
    }, {
      "Owner" : "9527951795****",
      "NodeName": "Node name",
      "NodeId" : 1234,
      "ProjectId" : 1234
    }, {
      "BaselineId" : 1234,
      "BaselineName": "Baseline name"
    }, {
      "ProjectId" : 1234
    }, {
      "BizProcessName": "Workflow name",
      "BizId" : 1234
    } ],
    "RemindName": "Rule name",
    "MaxAlertTimes" : 3
  },
  "ErrorCode" : 1031203110005,
  "ErrorMessage" : "The specified parameters are invalid.",
  "Success" : true
}

Error codes

HTTP status code Error code Error message Description
500 Forbidden.Not.Server The dataworksAPI service is not available in this area. Please try it in another area. The error message returned because 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.
403 Forbidden.Access Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. The error message returned because you are not allowed to perform this operation. Activate DataWorks Enterprise Edition or DataWorks Ultimate Edition.
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.Resource You have reached the limit for the resource. Please contact us by submitting a ticket. The error message returned because your quota for the resource has been reached. Submit a ticket.
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.

For a list of error codes, visit the API Error Center.