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

分页获取自定义监控告警规则

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
dataworks:ListAlertRules	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
Owner	string	否	自定义规则的责任人阿里云 UID。	1933790683****
TaskIds	array	否	调度任务 ID 列表
	long	否	调度任务 ID。	1234
Types	array	否	触发告警的类型列表。
	string	否	触发告警的类型，枚举值： Finished: 实例完成 UnFinished: 实例未完成 Error: 实例出错 CycleUnfinished: 实例周期未完成 Timeout: 实例超时 InstanceTransferComplete: 任务转实例完成 InstanceTransferFluctuate: 实例数量波动 ExhaustedError: 自动重跑后仍出错 InstanceKeyword: 出错实例包含关键词 InstanceErrorCount: 出错实例数量 InstanceErrorPercentage: 出错实例占比 ResourceGroupPercentage: 资源组利用率 ResourceGroupWaitCount: 资源组等资源实例数	Error
Receiver	string	否	告警接收人阿里云 UID。	1933790683****
Name	string	否	自定义规则名	error_rule
PageNumber	integer	是	页码数，用于翻页，最小值为 1。	1
PageSize	long	是	每页显示的条数，最大 100 条。	10

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求的 ID，用于定位日志，排查问题。	A6C6B486-E3A2-5D52-9E76-D9380485D946
PagingInfo	object	分页信息。
TotalCount	integer	满足条件的数据总条数。	5
PageNumber	integer	请求的数据页数，用于翻页。	1
PageSize	integer	每页显示的条数。	10
AlertRules	array<object>	一组自定义规则。
AlertRules	object
Id	long	自定义规则 ID。	22125
Name	string	自定义规则名。	error_test
Owner	string	自定义规则的责任人阿里云 UID。	1933790683****
Enabled	boolean	告警规则是否启用。	true
TriggerCondition	object	触发告警的条件。
Type	string	触发告警的类型，枚举值： Finished: 实例完成 UnFinished: 实例未完成 Error: 实例出错 CycleUnfinished: 实例周期未完成 Timeout: 实例超时 InstanceTransferComplete: 任务转实例完成 InstanceTransferFluctuate: 实例数量波动 ExhaustedError: 自动重跑后仍出错 InstanceKeyword: 出错实例包含关键词 InstanceErrorCount: 出错实例数量 InstanceErrorPercentage: 出错实例占比 ResourceGroupPercentage: 资源组利用率 ResourceGroupWaitCount: 资源组等资源实例数	Error
Extension	object	扩展信息，部分触发条件需要配置。
Error	object	出错告警配置。
StreamTaskIds	array	实时计算任务监控时填入对应的任务 ID
StreamTaskIds	long	实时计算任务 ID	123
AutoRerunAlert	boolean	离线任务由于失败自动重跑，是否产生告警	false
Timeout	object	超时告警配置
TimeoutInMinutes	integer	超时时间，单位为分钟。	10
UnFinished	object	未完成告警配置。
UnFinishedTime	string	未完成时间，格式为 hh:mm，hh 的取值范围为[0,47]，mm 的取值范围为[0,59]。	12:00
CycleUnfinished	object	周期未完成告警配置。
CycleAndTime	array<object>	周期和时间配置列表。
CycleAndTime	object
CycleId	integer	周期 ID，取值范围为[1,288]。	1
Time	string	未完成时间，格式为 hh:mm，hh 的取值范围为[0,47]，mm 的取值范围为[0,59]。	01:00
InstanceErrorCount	object	任务实例出错数量告警配置。
Count	integer	出错的任务实例数，取值范围为[1,10000]。	10
InstanceErrorPercentage	object	任务实例出错比例告警配置。
Percentage	integer	出错实例占比，取值范围 [1-100]。	10
InstanceTransferFluctuate	object	转实例数量波动告警配置。
Trend	string	转实例波动类型，枚举值： abs: 绝对值 increase: 增长 decrease: 下降	abs
Percentage	integer	转实例波动百分比，取值范围[1-100]。	10
Target	object	监控对象。
Type	string	监控对象类型，枚举值： Task: 任务节点 Baseline: 基线 Projec: 工作空间 BizProcess - 业务流程	Task
Ids	array	监控对象 ID 列表。
Ids	long	监控对象 ID。	32567
AllowTasks	array	监控任务白名单列表。
AllowTasks	long	监控任务白名单 ID。	123123

示例

正常返回示例

JSON格式

{
  "RequestId": "A6C6B486-E3A2-5D52-9E76-D9380485D946",
  "PagingInfo": {
    "TotalCount": 5,
    "PageNumber": 1,
    "PageSize": 10,
    "AlertRules": [
      {
        "Id": 22125,
        "Name": "error_test",
        "Owner": "1933790683****",
        "Enabled": true,
        "TriggerCondition": {
          "Type": "Error",
          "Extension": {
            "Error": {
              "StreamTaskIds": [
                123
              ],
              "AutoRerunAlert": false
            },
            "Timeout": {
              "TimeoutInMinutes": 10
            },
            "UnFinished": {
              "UnFinishedTime": "12:00"
            },
            "CycleUnfinished": {
              "CycleAndTime": [
                {
                  "CycleId": 1,
                  "Time": "01:00"
                }
              ]
            },
            "InstanceErrorCount": {
              "Count": 10
            },
            "InstanceErrorPercentage": {
              "Percentage": 10
            },
            "InstanceTransferFluctuate": {
              "Trend": "abs",
              "Percentage": 10
            }
          },
          "Target": {
            "Type": "Task",
            "Ids": [
              32567
            ],
            "AllowTasks": [
              123123
            ]
          }
        }
      }
    ]
  }
}

错误码

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史