调用ListReminds获取或搜索自定义监控规则列表。

调试

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

请求参数

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

要执行的操作。

PageNumber Integer 1

分页的页数。默认值为1,最小值为1,最大值为30。

PageSize Integer 10

每页显示的条数,默认为10条,最大100条。

RegionId String cn-shanghai

可用区的唯一标识。

Founder String 9527952795****

创建人的阿里云UID。

NodeId Long 1234

规则的对象,任务节点ID。您可以根据任务节点ID搜索覆盖该任务节点的自定义监控规则。

RemindTypes String FINISHED,ERROR

触发条件,包括FINISHED(完成)、UNFINISHED(未完成)、ERROR(出错)、CYCLE_UNFINISHED(周期未完成)和TIMEOUT(运行超时)。多个触发条件之间使用英文逗号(,)分隔。

AlertTarget String 9527952795****

报警接收人的阿里云UID。

SearchText String 模糊搜索规则名称

搜索规则名称。

返回数据

名称 类型 示例值 描述
Data Struct

返回的自定义监控规则列表。

PageNumber Integer 1

当前的页数。

PageSize Integer 10

每页的大小。

Reminds Array of Reminds

自定义监控规则列表。

AlertMethods List SMS

报警的方式,包括MAIL(邮件)、SMS(短信)和PHONE(电话,仅DataWorks专业版及以上版本支持)。

AlertTargets List 952795****

报警接收人的阿里云UID列表。

AlertUnit String OWNER

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

BaselineIds List 9527

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

BizProcessIds List 9527

当RemindUnit(对象类型)为BIZPROCESS(业务流程)时,监控的基线ID列表。

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 952795****

规则创建人的阿里云UID。

NodeIds List 1234

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

ProjectIds List 1234

当RemindUnit(对象类型)为PROJECT(工作空间)时,监控的节点ID列表。

RemindId Long 1234

自定义监控规则的ID。

RemindName String 规则名称

自定义监控规则的名称。

RemindType String FINISHED

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

RemindUnit String NODE

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

Useflag Boolean true

规则是否开启,包括true(开启)和false(关闭)。

TotalCount Integer 100

自定义监控规则的总数。

ErrorCode String 1031203110005

错误码。

ErrorMessage String The specified parameters are invalid.

错误信息。

HttpStatusCode Integer 200

HTTP返回码。

RequestId String 0000-ABCD-EFG****

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

Success Boolean true

调用是否成功。

示例

请求示例

http(s)://[Endpoint]/?Action=ListReminds
&PageNumber=1
&PageSize=10
&RegionId=cn-shanghai
&<公共请求参数>

正常返回示例

XML 格式

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

JSON 格式

{
    "RequestId": "0000-ABCD-EFG****",
    "HttpStatusCode": 200,
    "Data": {
        "TotalCount": 100,
        "PageSize": 10,
        "PageNumber": 1,
        "Reminds": [
            {
                "RemindId": 1234,
                "DndStart": "00:00",
                "DndEnd": "08:00",
                "AlertUnit": "OWNER",
                "RemindUnit": "NODE",
                "RemindType": "FINISHED",
                "Useflag": true,
                "Founder": "952795****",
                "RemindName": "规则名称"
            },
            {
                "BizProcessIds": 1234,
                "NodeIds": 1234,
                "AlertMethods": "SMS",
                "ProjectIds": 1234,
                "BaselineIds": 1234,
                "AlertTargets": "952795****"
            }
        ]
    },
    "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. 您的请求过于频繁,请尝试放缓请求速度。

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