全部產品
Search
文件中心

DataWorks:ListAlertRules - 擷取自訂規則列表

更新時間:Mar 21, 2026

分頁擷取自訂監控警示規則。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱

類型

必填

描述

樣本值

Owner

string

自訂規則的責任人阿里雲 UID。

1933790683****

TaskIds

array

調度任務 ID 列表

integer

調度任務 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

integer

每頁顯示的條數,最大 100 條。

10

返回參數

名稱

類型

描述

樣本值

object

Schema of Response

RequestId

string

請求的 ID,用於定位日誌,排查問題。

A6C6B486-E3A2-5D52-9E76-D938048****

PagingInfo

object

分頁資訊。

TotalCount

integer

滿足條件的資料總條數。

5

PageNumber

integer

請求的資料頁數,用於翻頁。

1

PageSize

integer

每頁顯示的條數。

10

AlertRules

array<object>

一組自訂規則。

array<object>

Id

integer

自訂規則 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

Realtime Compute任務監控時填入對應的任務 ID

integer

Realtime Compute任務 ID

123

AutoRerunAlertEnabled

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>

周期和時間配置列表。

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: 基準

  • Project: 工作空間

  • BizProcess - 商務程序

Task

Ids

array

監控物件識別碼 列表。

integer

監控物件識別碼。

32567

AllowTasks

array

監控任務白名單列表。

integer

監控任務白名單 ID。

123123

樣本

正常返回樣本

JSON格式

{
  "RequestId": "A6C6B486-E3A2-5D52-9E76-D938048****",
  "PagingInfo": {
    "TotalCount": 5,
    "PageNumber": 1,
    "PageSize": 10,
    "AlertRules": [
      {
        "Id": 22125,
        "Name": "error_test",
        "Owner": "1933790683****",
        "Enabled": true,
        "TriggerCondition": {
          "Type": "Error",
          "Extension": {
            "Error": {
              "StreamTaskIds": [
                123
              ],
              "AutoRerunAlertEnabled": 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
            ]
          }
        }
      }
    ]
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情