DataWorks でのカスタムアラートルール用の GetAlertRule API リファレンス - DataWorks

カスタムアラートモニタリングルールを照会します。

今すぐお試しください

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

テスト

RAM 認証

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

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Id	string	任意	ルール ID です。	28547072

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーターです。
RequestId	string	リクエスト ID です。	8abcb91f-d266-4073-b907-2ed670378ed1
AlertRule	object	ルールの情報です。
Id	integer	ルール ID です。	16035
Name	string	ルール名です。	error_rule
Owner	string	ルール所有者が使用する Alibaba Cloud アカウント ID です。	279961421580845157
Enabled	boolean	ルールが有効かどうかを示します。	true
Notification	object	アラート通知の構成です。
SilenceStartTime	string	サイレンスの開始時刻です。形式は HH:mm:ss です。	00:00:00
SilenceEndTime	string	サイレンスの終了時刻です。形式は HH:mm:ss です。	00:00:00
IntervalInMinutes	integer	アラート通知の送信間隔です。単位：分。有効範囲：[5, 10000]。	30
Maximum	integer	1 日（カレンダー日）あたりに送信可能なアラート通知の最大回数です。有効範囲：[1, 10000]。	3
Channels	array	アラート通知チャネルです。
	string	アラート通知チャネルです。有効な値： Mail Phone Sms：ショートメッセージ Dingding：DingTalk Feishu：Lark Weixin：WeCom Webhook：カスタム Webhook	Sms
Receivers	array<object>	アラート受信者です。
	object
ReceiverType	string	アラート受信者の種類です。有効な値： AliUid：Alibaba Cloud アカウント ID。 Shift Schedules：勤怠表に登録された担当者。 TaskOwner：タスク所有者。カスタムアラートおよびイベントアラートを受信できます。 Owner：ベースライン所有者。ベースラインアラートを受信できます。 WebhookUrl：カスタム Webhook の URL。 DingdingUrl：DingTalk Webhook の URL。 FeishuUrl：Lark Webhook の URL。 WeixinUrl：WeCom Webhook の URL。	WebhookUrl
ReceiverValues	array	アラート受信者です。
	string	アラート受信者の ID です。ReceiverType パラメーターが AliUid の場合、このパラメーターには Alibaba Cloud アカウント ID を指定します。ReceiverType が ShiftSchedule の場合、勤怠表 ID を指定します。ReceiverType が WebhookUrl、DingdingUrl、FeishuUrl、または WeixinUrl の場合、対応する URL を指定します。	123123123
Extension	string	アラート受信者の追加構成です。ReceiverType パラメーターが DingdingUrl の場合、{"atAll":true} を設定することで、DingTalk グループ内の全メンバーに通知できます。	{"atAll":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 です。	123123
AutoRerunAlertEnabled	boolean	バッチ同期タスクが失敗時に自動再実行された場合にアラートをトリガーするかどうかを示します。	false
Timeout	object	Timeout 型アラートの構成です。
TimeoutInMinutes	integer	タイムアウト期間です。単位：分。有効範囲：[1, 21600]。	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]。	12: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：インスタンス数が減少します。	10
Percentage	integer	ワークスペース内で自動トリガーされたノードによって生成されるインスタンス数の変動率の上限値です。有効範囲：[1, 100]。	10
Target	object	監視対象です。
Type	string	監視対象の種類です。有効な値： Task：ノード Baseline：ベースライン project：ワークスペース BizProcess：ワークフロー	Task
Ids	array	監視対象の ID です。
	integer	監視対象の ID です。	32570
AllowTasks	array	監視対象外とするノードです。
	integer	監視対象外とするノードの ID です。	123123

例

成功レスポンス

JSONJSON

{
  "RequestId": "8abcb91f-d266-4073-b907-2ed****",
  "AlertRule": {
    "Id": 16035,
    "Name": "error_rule",
    "Owner": "279961421580845157",
    "Enabled": true,
    "Notification": {
      "SilenceStartTime": "00:00:00",
      "SilenceEndTime": "00:00:00",
      "IntervalInMinutes": 30,
      "Maximum": 3,
      "Channels": [
        "Sms"
      ],
      "Receivers": [
        {
          "ReceiverType": "WebhookUrl",
          "ReceiverValues": [
            "123123123"
          ],
          "Extension": "{\"atAll\":true}"
        }
      ]
    },
    "TriggerCondition": {
      "Type": "Error",
      "Extension": {
        "Error": {
          "StreamTaskIds": [
            123123
          ],
          "AutoRerunAlertEnabled": false
        },
        "Timeout": {
          "TimeoutInMinutes": 10
        },
        "UnFinished": {
          "UnFinishedTime": "12:00"
        },
        "CycleUnfinished": {
          "CycleAndTime": [
            {
              "CycleId": 1,
              "Time": "12:00"
            }
          ]
        },
        "InstanceErrorCount": {
          "Count": 10
        },
        "InstanceErrorPercentage": {
          "Percentage": 10
        },
        "InstanceTransferFluctuate": {
          "Trend": "10",
          "Percentage": 10
        }
      },
      "Target": {
        "Type": "Task",
        "Ids": [
          32570
        ],
        "AllowTasks": [
          123123
        ]
      }
    }
  }
}

エラーコード

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

変更履歴

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