UpdateRemind によるカスタムアラートルールの変更 - DataWorks - Alibaba Cloud - DataWorks

カスタム監視ルールを更新します。

今すぐお試しください

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

テスト

RAM 認証

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

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RemindId	integer	必須	カスタムルールの ID。	1234
RemindName	string	任意	カスタムルールの名前。名前の長さは 128 文字以下です。	update_remindname
DndEnd	string	任意	サイレント期間の終了時間。この時間より前はアラートが送信されません。フォーマット: hh:mm。hh の有効な値: [0,23]。mm の有効な値: [0,59]。	08:00
RemindUnit	string	任意	監視対象のタイプ。有効な値: NODE BASELINE PROJECT (ワークスペース) BIZPROCESS (ビジネスプロセス) 列挙値: BASELINE : ベースライン。 PROJECT : ワークスペース。 NODE : ノード。 BIZPROCESS : ビジネスプロセス。	NODE
NodeIds	string	任意	監視対象がノードの場合のノード ID。1 つのルールで最大 50 個のノードをモニターできます。複数のノード ID はコンマ (,) で区切ります。このパラメーターは、RemindUnit が NODE にセットされている場合にのみ効果が得られます。	1,2,3
BaselineIds	string	任意	監視対象がベースラインの場合のベースライン ID。1 つのルールで最大 5 個のベースラインをモニターできます。複数のベースライン ID はコンマ (,) で区切ります。このパラメーターは、RemindUnit が BASELINE にセットされている場合にのみ効果が得られます。	1,2,3
ProjectId	integer	任意	監視対象がワークスペースの場合のワークスペース ID。1 つのルールでモニターできるワークスペースは 1 つだけです。このパラメーターは、RemindUnit が PROJECT にセットされている場合にのみ効果が得られます。	1234
BizProcessIds	string	任意	監視対象がビジネスプロセスの場合のビジネスプロセス ID。1 つのルールで最大 5 個のビジネスプロセスをモニターできます。複数のビジネスプロセス ID はコンマ (,) で区切ります。このパラメーターは、RemindUnit が BIZPROCESS にセットされている場合にのみ効果が得られます。	1,2,3
RemindType	string	任意	アラートルールをトリガーする条件。有効な値: FINISHED: システムは開始時刻からインスタンスをモニターし、ノードが正常に実行中になったときにアラートを送信します。 UNFINISHED: システムは開始時刻からインスタンスをモニターし、指定された目標時刻までにノードの実行が完了していない場合にアラートを送信します。 ERROR: システムは開始時刻からインスタンスをモニターし、ノードでエラーが発生したときにアラートを送信します。 CYCLE_UNFINISHED: 指定されたサイクル内にインスタンスの実行が完了していない場合、システムはアラートを送信します。これは通常、時間単位のサイクルで実行中のインスタンスをモニターするために使用されます。 TIMEOUT: システムは開始時刻からインスタンスをモニターし、指定された持続時間を経過してもノードの実行が完了していない場合にアラートを送信します。これは通常、インスタンスの実行時間をモニターするために使用されます。アラートのトリガー条件の詳細については、「カスタムルール」を参照してください。	FINISHED
MaxAlertTimes	integer	任意	アラートの最大値。有効な値: [1,10]。デフォルト値: 3。	3
AlertInterval	integer	任意	通知間隔 (秒単位)。最小値: 1200。デフォルト値: 1800。	1800
Detail	string	任意	異なるトリガー条件に対する構成の詳細: RemindType (トリガー条件) が FINISHED に設定されている場合、構成は空のままにします。 RemindType (トリガー条件) が UNFINISHED に設定されている場合、構成のフォーマットは {"hour":23,"minu":59} です。hour の有効な値: [0,47]。minu の有効な値: [0,59]。 RemindType (トリガー条件) が ERROR に設定されている場合、構成は空のままにします。 RemindType (トリガー条件) が CYCLE_UNFINISHED (サイクル未完了) に設定されている場合、構成のフォーマットは {"1":"05:50","2":"06:50","3":"07:50","4":"08:50","5":"09:50","6":"10:50","7":"11:50","8":"12:50","9":"13:50","10":"14:50","11":"15:50","12":"16:50","13":"17:50","14":"18:50","15":"19:50","16":"20:50","17":"21:50","18":"22:50","19":"23:50","20":"24:50","21":"25:50"} です。 JSON 文字列のキーはサイクル番号です。有効な値: [1,288]。値は対応するサイクルの未完了時刻であり、フォーマットは hh:mm です。hh の有効な値: [0,47]。mm の有効な値: [0,59]。 RemindType (トリガー条件) が TIMEOUT に設定されている場合、構成のフォーマットは 1800 (秒単位) です。これは、インスタンスが 30 分以上実行中の場合にアラートがトリガーされることを意味します。	{"hour":23,"minu":59}
AlertUnit	string	任意	アラートの受信者。有効な値: OWNER: ノードのオーナー。 OTHER: 指定されたユーザー。列挙値: OTHER : 指定されたユーザー。 OWNER : ノードのオーナー。	OWNER
AlertMethods	string	任意	アラート通知方法。有効な値: MAIL SMS PHONE。電話アラートは DataWorks Professional Edition 以上でのみサポートされています。 DINGROBOTS (DingTalk チャットボット)。このメソッドは、RobotUrls パラメーターが設定された後にのみ効果が得られます。 Webhooks (WeCom または Lark チャットボット)。このメソッドは、Webhooks パラメーターが設定された後にのみ効果が得られます。複数のアラート方法はコンマ (,) で区切ります。	SMS,MAIL
AlertTargets	string	任意	異なるアラート受信者に対する構成の詳細: AlertUnit が OWNER (ノードのオーナー) に設定されている場合、構成は空のままにします。 AlertUnit が OTHER (指定されたユーザー) に設定されている場合、このパラメーターに指定されたユーザーの Alibaba Cloud UID を設定します。複数の UID はコンマ (,) で区切ります。アラートを受信するユーザーは最大 10 人まで指定できます。	9527952795279527
UseFlag	boolean	任意	アラートルールを有効にするかどうかを指定します。有効な値: true: 有効。 false: 無効。	true
RobotUrls	string	任意	DingTalk グループチャットボットの Webhook URL。複数の Webhook URL はコンマ (,) で区切ります。パラメータ設定が undefined にセットされている場合、システムは DingTalk チャットボットの Webhook URL をクリアします。	https://oapi.dingtalk.com/robot/send?access_token=******************************
Webhooks	string	任意	WeCom または Lark チャットボットの Webhook URL。複数の Webhook URL はコンマ (,) で区切ります。alertMethods パラメーターには WEBHOOKS アラート機能を含める必要があります。パラメーターが undefined にセットされている場合、システムは Webhook URL をクリアします。 DataWorks Enterprise Edition のみがサポートされています。利用可能なリージョン: 中国 (上海)、中国 (成都)、中国 (張家口)、中国 (北京)、中国 (杭州)、中国 (深セン)、中国 (香港)、ドイツ (フランクフルト)、アジア太平洋東南部 1 (シンガポール)。	https://open.feishu.cn/open-apis/bot/v2/hook/*******

レスポンスフィールド

フィールド	型	説明	例
	object
HttpStatusCode	integer	HTTP 状態コード。	200
Data	boolean	カスタム監視ルールの更新結果。	true
ErrorMessage	string	エラーメッセージ。	The specified parameters are invalid.
RequestId	string	リクエストの一意の ID。この ID を使用して問題のトラブルシューティングを行えます。	0000-ABCD-EFG****
Success	boolean	呼び出しが成功したかどうかを示します。有効な値: true: 成功。 false: 失敗。	true
ErrorCode	string	エラーコード。	1031203110005

例

成功レスポンス

JSONJSON

{
  "HttpStatusCode": 200,
  "Data": true,
  "ErrorMessage": "The specified parameters are invalid.",
  "RequestId": "0000-ABCD-EFG****",
  "Success": true,
  "ErrorCode": "1031203110005"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
500	Forbidden.Not.Server	The dataworksAPI service is not available in this area. Please try it in another area.
500	Forbidden.Wkbench.BaselineNoPermission	You are not authorized to access the baseline.
500	Forbidden.Wkbench.ProjectNoPermission	You are not authorized to access the workspace.
500	InternalError.System	An internal system error occurred. Try again later.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.
500	Forbidden.Wkbench.RemindNoPermission	You are not authorized to modify the reminder.
500	Invalid.Wkbench.RemindNotExist	The reminder does not exist.
429	Throttling.Api	The request for this resource has exceeded your available limit.
429	Throttling.Api.Risk	The request for this resource has exceeded your daily available limit.
429	Throttling.Resource	You have reached the limit for the resource. Please contact us by submitting a ticket.
429	Throttling.System	The DataWorks system is busy. Try again later.
429	Throttling.User	Your request is too frequent. Try again later.

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

変更履歴

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