全部产品
Search

搜索本产品

    大数据开发治理平台 DataWorks：ListReminds - 获取自定义监控规则列表

    文档中心

    大数据开发治理平台 DataWorks：ListReminds - 获取自定义监控规则列表

    更新时间：Nov 15, 2024

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

    调试

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

    授权信息

    当前API暂无授权信息透出。

    请求参数

    名称类型必填描述示例值
    PageNumberinteger是

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

    		1
    PageSizeinteger是

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

    		10
    Founderstring否

    创建人的阿里云 UID。

    		9527952795****
    NodeIdlong否

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

    		1234
    RemindTypesstring否

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

    		FINISHED,ERROR
    AlertTargetstring否

    报警接收人的阿里云 UID。

    		9527952795****
    SearchTextstring否

    搜索规则名称。

    		模糊搜索规则名称

    返回参数

    名称类型描述示例值
    object
    HttpStatusCodeinteger

    HTTP 返回码。

    		200
    RequestIdstring

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

    		0000-ABCD-EFG****
    ErrorMessagestring

    错误信息。

    		The specified parameters are invalid.
    ErrorCodestring

    错误码。

    		1031203110005
    Successboolean

    调用是否成功。

    		true
    Dataobject

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

    PageNumberinteger

    当前的页数。

    		1
    PageSizeinteger

    每页的大小。

    		10
    TotalCountinteger

    自定义监控规则的总数。

    		100
    Remindsarray<object>

    自定义监控规则列表。

    Remindsobject

    自定义监控规则列表。

    Founderstring

    规则创建人的阿里云 UID。

    		952795****
    RemindIdlong

    自定义监控规则的 ID。

    		1234
    AlertUnitstring

    报警接收对象的粒度，包括 OWNER（任务责任人）和 OTHER（指定的人）。

    		OWNER
    RemindTypestring

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

    		FINISHED
    DndEndstring

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

    		08:00
    DndStartstring

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

    		00:00
    RemindUnitstring

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

    		NODE
    Useflagboolean

    规则是否开启，包括 true（开启）和 false（关闭）。

    		true
    RemindNamestring

    自定义监控规则的名称。

    		规则名称
    AlertTargetsarray

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

    AlertTargetsstring

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

    		952795****
    NodeIdsarray

    当 RemindUnit（对象类型）为 NODE（任务节点）时，监控的节点 ID 列表。

    NodeIdslong

    当 RemindUnit（对象类型）为 NODE（任务节点）时，监控的节点 ID 列表。

    		1234
    BizProcessIdsarray

    当 RemindUnit（对象类型）为 BIZPROCESS（业务流程）时，监控的基线 ID 列表。

    BizProcessIdslong

    当 RemindUnit（对象类型）为 BIZPROCESS（业务流程）时，监控的基线 ID 列表。

    		9527
    ProjectIdsarray

    当 RemindUnit（对象类型）为 PROJECT（工作空间）时，监控的节点 ID 列表。

    ProjectIdslong

    当 RemindUnit（对象类型）为 PROJECT（工作空间）时，监控的节点 ID 列表。

    		1234
    BaselineIdsarray

    当 RemindUnit（对象类型）为 BASELINE（基线）时，监控的基线 ID 列表。

    BaselineIdslong

    当 RemindUnit（对象类型）为 BASELINE（基线）时，监控的基线 ID 列表。

    		9527
    AlertMethodsarray

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

    AlertMethodsstring

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

    		SMS

    示例

    正常返回示例

    JSON格式

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

    错误码

    HTTP status code错误码错误信息描述
    403Forbidden.AccessAccess is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.没有权限，请授权
    429Throttling.ApiThe request for this resource has exceeded your available limit.对该资源的请求已超过您的可用上限。
    429Throttling.Api.RiskThe request for this resource has exceeded your daily available limit.对该资源的请求已超过您的每日可用上限。
    429Throttling.SystemThe DataWorks system is busy. Try again later.DataWorks系统繁忙，请稍后再试。
    429Throttling.UserYour request is too frequent. Try again later.您的请求过于频繁，请尝试放缓请求速度。
    500Forbidden.Not.ServerThe dataworksAPI service is not available in this area. Please try it in another area.该地域还未开放DataWorks的API服务，请尝试其它地域。
    500InternalError.SystemAn internal system error occurred. Try again later.系统内部错误，请稍后再试。
    500InternalError.UserId.MissingAn internal system error occurred. Try again later.系统内部错误，请稍后再试。

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

    变更历史

    变更时间变更内容概要操作
    暂无变更历史