すべてのプロダクト
Search
ドキュメントセンター

DataWorks:ListAlertRules

最終更新日:Mar 21, 2026

カスタム監視アラートルールの一覧を照会します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエストパラメーター

パラメーター

必須 / 任意

説明

Owner

string

任意

ルールの所有者として使用される Alibaba Cloud アカウントの ID です。

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

任意

アラート受信者として使用される Alibaba Cloud アカウントの ID です。

1933790683****

Name

string

任意

ルールの名前です。

error_rule

PageNumber

integer

必須

ページ番号です。1 ページ目から開始されます。

1

PageSize

integer

必須

1 ページあたりの件数です。最大値は 100 です。

10

レスポンスフィールド

フィールド

説明

object

レスポンスパラメーターです。

RequestId

string

リクエスト ID です。

A6C6B486-E3A2-5D52-9E76-D9380485D946

PagingInfo

object

ページネーション情報です。

TotalCount

integer

返却される総件数です。

5

PageNumber

integer

ページ番号です。

1

PageSize

integer

1 ページあたりの件数です。

10

AlertRules

array<object>

アラートルールです。

array<object>

Id

integer

ルール ID です。

22125

Name

string

ルールの名前です。

error_test

Owner

string

ルールの所有者として使用される Alibaba Cloud アカウントの ID です。

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

Error 型アラートの構成です。

StreamTaskIds

array

リアルタイムコンピューティングタスクの ID です。リアルタイムコンピューティングタスクを監視する場合に必須です。

integer

リアルタイムコンピューティングタスクの ID です。

123

AutoRerunAlertEnabled

boolean

バッチ同期タスクが失敗時に自動再実行された場合にアラートをトリガーするかどうかを示します。

false

Timeout

object

Timeout 型アラートの構成です。

TimeoutInMinutes

integer

タイムアウト期間です。単位:分。

10

UnFinished

object

UnFinished 型アラートの構成です。

UnFinishedTime

string

インスタンスの最新完了時刻です。hh:mm 形式で指定します。hh の有効範囲:[0,47]、mm の有効範囲:[0,59] です。

12:00

CycleUnfinished

object

CycleUnfinished 型アラートの構成です。

CycleAndTime

array<object>

インスタンスのスケジューリングサイクルおよびタイムアウト期間の構成です。

object

CycleId

integer

インスタンスのスケジューリングサイクル ID です。有効値:[1,288]。

1

Time

string

スケジューリングサイクル内におけるインスタンスの最新完了時刻です。hh:mm 形式で指定します。hh の有効範囲:[0,47]、mm の有効範囲:[0,59] です。

01:00

InstanceErrorCount

object

InstanceErrorCount 型アラートの構成です。

Count

integer

エラーが発生したインスタンス数の上限値です。有効値:[1,10000]。

10

InstanceErrorPercentage

object

InstanceErrorPercentage 型アラートの構成です。

Percentage

integer

ワークスペース内のエラー発生インスタンス数が、全体のインスタンス数に占める割合の上限値です。有効値:[1,100]。

10

InstanceTransferFluctuate

object

InstanceTransferFluctuate 型アラートの構成です。

Trend

string

ワークスペース内で自動トリガーされたノードによって生成されるインスタンス数の変動方法です。有効な値は以下のとおりです。

  • abs:絶対値。インスタンス数が増加または減少します。

  • increase:インスタンス数が増加します。

  • decrease:インスタンス数が減少します。

abs

Percentage

integer

ワークスペース内で自動トリガーされたノードによって生成されるインスタンス数の変動率の上限値です。有効値:[1,100]。

10

Target

object

監視対象です。

Type

string

監視対象の種類です。有効な値は以下のとおりです。

  • Task:ノード

  • Baseline:ベースライン

  • Project:ワークスペース

  • BizProcess:ワークフロー

Task

Ids

array

監視対象の ID です。

integer

監視対象の ID です。

32567

AllowTasks

array

監視対象外とするノードです。

integer

監視対象外とするノードの ID です。

123123

成功レスポンス

JSONJSON

{
  "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
            ]
          }
        }
      }
    ]
  }
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。