Queries the details of a custom monitoring alarm 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 Required GetRemind

The operation that you want to perform.

RegionId String Required cn-shanghai

The unique identifier of the zone.

RemindId Long Yes 1234

The ID of the custom monitoring rule.

Response parameters

Parameter Type Example Description
Data Struct

The details of the custom monitoring rule.

AlertInterval Integer 1800

The minimum alert interval. Unit: seconds.

AlertMethods List SMS,MAIL

The alert method. Valid values: MAIL, SMS, and PHONE. PHONE number: DataWorks Professional Edition and later. Separate multiple notification methods with commas (,).

AlertTargets List 9527952795279527
  • When AlertUnit is the OWNER, an empty error is returned.
  • The Alibaba Cloud UID of the specified user is returned when AlertUnit is OTHER. Separate multiple Alibaba Cloud UIDs with commas (,).
AlertUnit String OWNER

The granularity of the object that is used to receive alerts. Valid values: OWNER and OTHER.

Baselines Array

The list of baselines to be monitored by this rule when the value of the credunit (object type) parameter is BASELINE.

BaselineId Long 1234

The ID of the baseline.

BaselineName String Baseline check

The name of the baseline.

BizProcesses Array

The list of workflow monitored by this rule when the value of workflow is BIZPROCESS.

BizId Long 9527

workflow ID

BizProcessName String Workflow name

Workflow name

Detail String {"hour":23,"minu":59}
  • An empty result is returned when the value of the mindtype parameter is FINISHED.
  • When mindtype is set to UNFINISHED, the returned format is {"hour":23,"minu":59}. The value range of hour is [0,47] and the value range of minu is [0,59].
  • No value is returned if the value of the mindtype parameter is ERROR.
  • If the value of the credtype (trigger condition) parameter is CYCLE_UNFINISHED (the cycle is not completed), The Returned time is in the following format: {"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 value of key in the JSON string indicates the period, in the range of [1,288]. The value is the time when the time is not completed in the cycle, in the format of hh:mm. The value range of hh is [0,47], and the value range of mm is [0,59].
  • When the retindtype parameter is set to TIMEOUT, the response format is 1800. Unit: seconds. After running, an alert is triggered for more than 30 minutes.
DndEnd String 08:00

The skip end time. The time is in the hh:mm format. The value range of hh is [0,23]. The value range of mm is [0,59].

DndStart String 00:00

The start time for the default disturb mode. The format is hh:mm. The value range of hh is [0,23]. The value range of mm is [0,59].

Founder String 9527951795****

The unique ID (UID) of the user that creates the custom monitoring rule.

MaxAlertTimes Integer 3

Maximum number of alarms.

Nodes Array

This parameter specifies the NODE list of the specified rule when the specified memordunit parameter is set to NODE.

NodeId Long 1234

The ID of the node.

NodeName String The name of the node

The name of the node.

Owner String 9527951795****

The UID of the node owner.

ProjectId Long 1234

The ID of the workspace to which the node belongs.

Projects Array

The workspace name list monitored by this rule when the value of mindunit (object type) is PROJECT.

ProjectId Long 1234

The ID of the DataWorks workspace.

RemindId Long 1234

The ID of the custom monitoring rule.

RemindName String Rule Name

The name of the rule.

RemindType String FINISHED

The trigger condition, including FINISHED, UNFINISHED, ERROR, CYCLE_UNFINISHED, and TIMEOUT.

RemindUnit String NODE

The type of the object. Valid values: NODE, BASELINE, PROJECT, and workflow.

Robots Array

DingTalk the webhook address list of the chatbot.

AtAll Boolean true

Specifies whether to @ all members. Valid values: true and false.

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

DingTalk the webhook address of the chatbot.

Useflag Boolean true

Indicates whether custom monitoring rules are enabled. Valid values: true and false.

ErrorCode String 1031203110005

The error code.

ErrorMessage String The specified parameters are invalid.

The returned message.

HttpStatusCode Integer 200

The HTTP status code.

RequestId String 0000-ABCD-EFGH-IJKLMNOPQ

The unique ID of the call. You can use the error ID to troubleshoot the error.

Success Boolean true

Indicates whether the call is successful.

Examples

Sample requests

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

Sample success responses

XML format

<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

{
    "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
            }
        ],
        "Mindname": "Rule name",
        "MaxAlertTimes": 3
    },
    "ErrorCode": 1031203110005,
    "ErrorMessage": "The specified parameters are invalid.",
    "Success": true
}

Error code

HttpCode Error code Error message Description
403 Forbidden.Access Access is forbidden. Activate DataWorks first. Your access is restricted, possibly because you have not activated DataWorks.
500 Forbidden.Not.Server The dataworksAPI service is not available in this area. Please try it in another area. DataWorks API service is not available in this region. Please try another region.
500 InternalError.System An internal system error occurred. Try again later. An internal system error occurred. Please try again later.
500 InternalError.UserId.Missing An internal system error occurred. Try again later. An internal system error occurred. Please try again later.
500 InternalError.Wkbench.ServiceError An internal error occurred. The service was open.
500 Invalid.Wkbench.Parameter The specified parameters are invalid. The parameters are invalid.
403 ResourceNotAuthorized.Api You are not authorized to access the resources. You cannot access resources without authorization.
429 Throttling.Api The request for this resource has exceeded your available limit. The request for the resource exceeds your available upper limit.
429 Throttling.Api.Risk The request for this resource has exceeded your daily available limit. The request for the resource has exceeded your daily availability limit.
429 Throttling.Resource You have reached the limit for the resource. Please contact us by submitting a ticket. The number of resources has reached the upper limit. Submit a ticket.
429 Throttling.System The DataWorks system is busy. Try again later. DataWorks the system is busy, please try again later.
429 Throttling.User Your request is too frequent. Try again later. Your request is too frequent, please try to slow down the request speed.
500 Invalid.Wkbench.RemindNotExist The reminder does not exist. The custom reminder rule does not exist.

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