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

ParameterTypeRequiredExampleDescription
ActionStringYesGetRemind

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

RemindIdLongYes1234

The ID of the custom alert rule.

Response parameters

ParameterTypeExampleDescription
HttpStatusCodeInteger200

The HTTP status code.

RequestIdString0000-ABCD-EFGH-IJKLMNOPQ

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

ErrorMessageStringThe specified parameters are invalid.

The error message.

ErrorCodeString1031203110005

The error code.

SuccessBooleantrue

Indicates whether the request was successful.

DataObject

The details of the custom alert rule.

MaxAlertTimesInteger3

The maximum number of alerts.

RemindUnitStringNODE

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.

AlertIntervalInteger1800

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

UseflagBooleantrue

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

FounderString9527951795****

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

RemindIdLong1234

The ID of the custom alert rule.

DndEndString08: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.

RemindTypeStringFINISHED

The conditions that trigger an alert for the node. Valid values: FINISHED, UNFINISHED, ERROR, CYCLE_UNFINISHED, and TIMEOUT. The value FINISHED indicates that the node finishes running. 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 does not finish running in the specified scheduling cycle. The value TIMEOUT indicates that the node times out.

AlertUnitStringOWNER

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

DndStartString00: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.

RemindNameStringRule name

The name of the custom alert rule.

DetailString{"hour":23,"minu":59}
  • 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 of the ID: 1 to 288. The value indicates the timeout period of the node that is running 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 has run for more than 30 minutes.
RobotsArray of Robots

The webhook URLs of the DingTalk chatbots.

WebUrlStringhttps://oapi.dingtalk.com/robot/send?access_token=******************************

The webhook URL of the DingTalk chatbot.

AtAllBooleantrue

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

NodesArray 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.

OwnerString9527951795****

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

NodeNameStringNode name

The name of the node.

NodeIdLong1234

The ID of the node.

ProjectIdLong1234

The ID of the workspace to which the node belongs.

BaselinesArray 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.

BaselineNameStringBaseline name

The name of the baseline.

BaselineIdLong1234

The ID of the baseline.

ProjectsArray 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.

ProjectIdLong1234

The ID of the workspace.

BizProcessesArray 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.

BizProcessNameStringWorkflow name

The name of the workflow.

BizIdLong9527

The ID of the workflow.

AlertTargetsArray of String9527952795279527
  • 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 (,).
AlertMethodsArray of StringSMS,MAIL

The notification method. Valid values:

  • MAIL
  • SMS

    Alert notifications can be sent by text messages only in the Singapore, Malaysia (Kuala Lumpur), and Germany (Frankfurt) regions.

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

WebhooksArray of Stringhttps://open.feishu.cn/open-apis/bot/v2/hook/*******

The webhook URL of the WeCom or Lark chatbot. If multiple webhook URLs are involved, the webhook URLs are separated by commas (,). The value of AlertMethods must include WEBHOOKS. Only DataWorks Enterprise Edition supports this parameter.

The webhook URL-based alerting feature is supported in the following regions: China (Shanghai), China (Chengdu), China (Zhangjiakou), China (Beijing), China (Hangzhou), China (Shenzhen), China (Hong Kong), Germany (Frankfurt), and Singapore.

Examples

Sample requests

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

Sample success responses

XML format

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

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

JSON format

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

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

Error codes

HTTP status codeError codeError messageDescription
429Throttling.ApiThe request for this resource has exceeded your available limit.The number of requests for the resource has exceeded the upper limit.
429Throttling.Api.RiskThe request for this resource has exceeded your daily available limit.The number of requests per day for the resource has exceeded the upper limit.
429Throttling.SystemThe DataWorks system is busy. Try again later.The DataWorks system is busy. Try again later.
429Throttling.UserYour request is too frequent. Try again later.Excessive requests have been submitted within a short period of time. Try again later.
500Forbidden.Not.ServerThe dataworksAPI service is not available in this area. Please try it in another area.DataWorks API is unavailable in this region. Try another region.
500InternalError.SystemAn internal system error occurred. Try again later.An internal error has occurred. Try again later.
500InternalError.UserId.MissingAn 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.