调用GetRemind获取自定义监控报警规则的详情。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String GetRemind

要执行的操作。

RegionId String cn-shanghai

可用区的唯一标识。

RemindId Long 1234

自定义监控规则的ID。

返回数据

名称 类型 示例值 描述
Data Struct

自定义监控规则的详情。

AlertInterval Integer 1800

最小报警间隔,单位为秒。

AlertMethods List SMS,MAIL

报警的方式,包括MAIL(邮件)、SMS(短信)和PHONE(电话,仅DataWorks专业版及以上版本支持)。多个报警方式之间使用英文逗号(,)分隔。

AlertTargets List 9527952795279527
  • 当AlertUnit(报警接收人)为OWNER(节点任务责任人)时,返回空。
  • 当AlertUnit(报警接收人)为OTHER(指定的人)时,返回指定用户的阿里云UID。多个阿里云UID之间使用英文逗号(,)分隔。
AlertUnit String OWNER

报警接收对象的粒度,包括OWNER(任务责任人)和OTHER(指定的人)。

Baselines Array

当RemindUnit(对象类型)为BASELINE(基线)时,该规则监控的基线列表。

BaselineId Long 1234

基线的ID。

BaselineName String 基线名称

基线的名称。

BizProcesses Array

当RemindUnit(对象类型)为BIZPROCESS(业务流程)时,该规则监控的业务流程列表。

BizId Long 9527

业务流程ID

BizProcessName String 业务流程名称

业务流程名称

Detail String {"hour":23,"minu":59}
  • 当RemindType(触发条件)为FINISHED(完成)时,返回空。
  • 当RemindType(触发条件)为UNFINISHED(未完成)时,返回格式为{"hour":23,"minu":59}。hour的取值范围为[0,47],minu的取值范围为[0,59]。
  • 当RemindType(触发条件)为ERROR(出错)时,返回空。
  • 当RemindType(触发条件)为CYCLE_UNFINISHED(周期未完成)时,返回格式为{"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"}。JSON字符串key为周期号,取值范围为[1,288]。value为该周期对应的未完成时间,格式为hh:mm。hh的取值范围为[0,47],mm的取值范围为[0,59]。
  • 当RemindType(触发条件)为TIMEOUT(运行超时)时,返回格式为1800,单位为秒。即从开始运行起,运行超过30分钟触发报警。
DndEnd String 08:00

免打扰截止时间,格式为hh:mm。hh的取值范围为[0,23],mm的取值范围为[0,59]。

DndStart String 00:00

免打扰起始时间,格式为hh:mm。hh的取值范围为[0,23],mm的取值范围为[0,59]。

Founder String 9527951795****

自定义监控规则创建人的阿里云UID。

MaxAlertTimes Integer 3

最大报警次数。

Nodes Array

当RemindUnit(对象类型)为NODE(任务节点)时,该规则监控的节点列表。

NodeId Long 1234

节点的ID。

NodeName String 节点名称

节点的名称。

Owner String 9527951795****

节点责任人的阿里云UID。

ProjectId Long 1234

节点所在工作空间的ID。

Projects Array

当RemindUnit(对象类型)为PROJECT(工作空间)时,该规则监控的工作空间列表。

ProjectId Long 1234

工作空间的ID。

RemindId Long 1234

自定义监控规则的ID。

RemindName String 规则名称

规则的名称。

RemindType String FINISHED

触发条件,包括FINISHED(完成)、UNFINISHED(未完成)、ERROR(出错)、CYCLE_UNFINISHED(周期未完成)和TIMEOUT(运行超时)。

RemindUnit String NODE

对象的类型,包括NODE(任务节点)、BASELINE(基线)、PROJECT(工作空间)和BIZPROCESS(业务流程)。

Robots Array

钉钉群机器人的webhook地址列表。

AtAll Boolean true

是否@所有人,包括true(是)和false(否)。

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

钉钉群机器人的webhook地址。

Useflag Boolean true

自定义监控规则是否开启,包括true(开启)和false(关闭)。

ErrorCode String 1031203110005

错误码。

ErrorMessage String The specified parameters are invalid.

错误信息。

HttpStatusCode Integer 200

HTTP返回码。

RequestId String 0000-ABCD-EFGH-IJKLMNOPQ

本次调用的唯一ID。出现错误后,您可以根据该ID排查问题。

Success Boolean true

调用是否成功。

示例

请求示例

http(s)://[Endpoint]/?Action=GetRemind
&RegionId=cn-shanghai
&RemindId=1234
&<公共请求参数>

正常返回示例

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>节点名称</NodeName>
        <NodeId>1234</NodeId>
        <ProjectId>1234</ProjectId>
    </BizProcesses>
    <BizProcesses>
        <BaselineId>1234</BaselineId>
        <BaselineName>基线名称</BaselineName>
    </BizProcesses>
    <BizProcesses>
        <ProjectId>1234</ProjectId>
    </BizProcesses>
    <BizProcesses>
        <BizProcessName>业务流程名称</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>节点名称</NodeName>
        <NodeId>1234</NodeId>
        <ProjectId>1234</ProjectId>
    </Projects>
    <Projects>
        <BaselineId>1234</BaselineId>
        <BaselineName>基线名称</BaselineName>
    </Projects>
    <Projects>
        <ProjectId>1234</ProjectId>
    </Projects>
    <Projects>
        <BizProcessName>业务流程名称</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>节点名称</NodeName>
        <NodeId>1234</NodeId>
        <ProjectId>1234</ProjectId>
    </Nodes>
    <Nodes>
        <BaselineId>1234</BaselineId>
        <BaselineName>基线名称</BaselineName>
    </Nodes>
    <Nodes>
        <ProjectId>1234</ProjectId>
    </Nodes>
    <Nodes>
        <BizProcessName>业务流程名称</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>节点名称</NodeName>
        <NodeId>1234</NodeId>
        <ProjectId>1234</ProjectId>
    </Baselines>
    <Baselines>
        <BaselineId>1234</BaselineId>
        <BaselineName>基线名称</BaselineName>
    </Baselines>
    <Baselines>
        <ProjectId>1234</ProjectId>
    </Baselines>
    <Baselines>
        <BizProcessName>业务流程名称</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>节点名称</NodeName>
        <NodeId>1234</NodeId>
        <ProjectId>1234</ProjectId>
    </Robots>
    <Robots>
        <BaselineId>1234</BaselineId>
        <BaselineName>基线名称</BaselineName>
    </Robots>
    <Robots>
        <ProjectId>1234</ProjectId>
    </Robots>
    <Robots>
        <BizProcessName>业务流程名称</BizProcessName>
        <BizId>1234</BizId>
    </Robots>
    <RemindName>规则名称</RemindName>
    <MaxAlertTimes>3</MaxAlertTimes>
</Data>
<ErrorCode>1031203110005</ErrorCode>
<ErrorMessage>The specified parameters are invalid.</ErrorMessage>
<Success>true</Success>

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": "节点名称",
                "NodeId": 1234,
                "ProjectId": 1234
            },
            {
                "BaselineId": 1234,
                "BaselineName": "基线名称"
            },
            {
                "ProjectId": 1234
            },
            {
                "BizProcessName": "业务流程名称",
                "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": "节点名称",
                "NodeId": 1234,
                "ProjectId": 1234
            },
            {
                "BaselineId": 1234,
                "BaselineName": "基线名称"
            },
            {
                "ProjectId": 1234
            },
            {
                "BizProcessName": "业务流程名称",
                "BizId": 1234
            }
        ],
        "RemindType": "FINISHED",
        "Founder": "9527951795****",
        "Nodes": [
            {
                "AtAll": true,
                "WebUrl": "https://oapi.dingtalk.com/robot/send?access_token=******************************"
            },
            {
                "Owner": "9527951795****",
                "NodeName": "节点名称",
                "NodeId": 1234,
                "ProjectId": 1234
            },
            {
                "BaselineId": 1234,
                "BaselineName": "基线名称"
            },
            {
                "ProjectId": 1234
            },
            {
                "BizProcessName": "业务流程名称",
                "BizId": 1234
            }
        ],
        "Baselines": [
            {
                "AtAll": true,
                "WebUrl": "https://oapi.dingtalk.com/robot/send?access_token=******************************"
            },
            {
                "Owner": "9527951795****",
                "NodeName": "节点名称",
                "NodeId": 1234,
                "ProjectId": 1234
            },
            {
                "BaselineId": 1234,
                "BaselineName": "基线名称"
            },
            {
                "ProjectId": 1234
            },
            {
                "BizProcessName": "业务流程名称",
                "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": "节点名称",
                "NodeId": 1234,
                "ProjectId": 1234
            },
            {
                "BaselineId": 1234,
                "BaselineName": "基线名称"
            },
            {
                "ProjectId": 1234
            },
            {
                "BizProcessName": "业务流程名称",
                "BizId": 1234
            }
        ],
        "RemindName": "规则名称",
        "MaxAlertTimes": 3
    },
    "ErrorCode": 1031203110005,
    "ErrorMessage": "The specified parameters are invalid.",
    "Success": true
}

错误码

HttpCode 错误码 错误信息 描述
403 Forbidden.Access Access is forbidden. Activate DataWorks first. 您被限制访问,可能是由于您还未激活DataWorks。
500 Forbidden.Not.Server The dataworksAPI service is not available in this area. Please try it in another area. 该地域还未开放DataWorks的API服务,请尝试其它地域。
500 InternalError.System An internal system error occurred. Try again later. 系统内部错误,请稍后再试。
500 InternalError.UserId.Missing An internal system error occurred. Try again later. 系统内部错误,请稍后再试。
500 InternalError.Wkbench.ServiceError An internal error occurred. 服务开小差了。
500 Invalid.Wkbench.Parameter The specified parameters are invalid. 参数错误。
403 ResourceNotAuthorized.Api You are not authorized to access the resources. 您无法访问未取得授权的资源。
429 Throttling.Api The request for this resource has exceeded your available limit. 对该资源的请求已超过您的可用上限。
429 Throttling.Api.Risk The request for this resource has exceeded your daily available limit. 对该资源的请求已超过您的每日可用上限。
429 Throttling.Resource You have reached the limit for the resource. Please contact us by submitting a ticket. 该资源已经达到您的使用上限,请提交工单进行咨询。
429 Throttling.System The DataWorks system is busy. Try again later. DataWorks系统繁忙,请稍后再试。
429 Throttling.User Your request is too frequent. Try again later. 您的请求过于频繁,请尝试放缓请求速度。
500 Invalid.Wkbench.RemindNotExist The reminder does not exist. 自定义提醒规则不存在。

访问错误中心查看更多错误码。