CreateRemind によるカスタムアラートルールの作成 - DataWorks - Alibaba Cloud - DataWorks

カスタムアラートルールを作成します。

今すぐお試しください

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

テスト

RAM 認証

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

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RemindName	string	必須	カスタムルールの名前。名前の長さは最大 128 文字です。	test_error_remind
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	任意	RemindUnit (オブジェクトタイプ) が NODE (ノード) にセットされている場合にモニターするノードの ID。複数の ID はコンマ (,) で区切ります。単一のルールでモニターできるノードの最大値は 50 個です。	1,2,3
BaselineIds	string	任意	RemindUnit (オブジェクトタイプ) が BASELINE (ベースライン) にセットされている場合にモニターするベースラインの ID。複数の ID はコンマ (,) で区切ります。単一のルールでモニターできるベースラインの最大値は 5 個です。	1,2,3
ProjectId	integer	任意	RemindUnit (オブジェクトタイプ) が PROJECT (ワークスペース) に設定されている場合にモニターするワークスペースの ID。単一のルールでモニターできるワークスペースは 1 つだけです。	9527
BizProcessIds	string	任意	RemindUnit (オブジェクトタイプ) が BIZPROCESS (ビジネスプロセス) にセットされている場合にモニターするビジネスプロセスの ID。複数のビジネスプロセス ID はコンマ (,) で区切ります。単一のルールでモニターできるビジネスプロセスの最大値は 5 個です。	1,2,3
RemindType	string	必須	トリガー条件。有効な値: FINISHED (完了)、UNFINISHED (未完了)、ERROR (エラー)、CYCLE_UNFINISHED (サイクル未完了)、TIMEOUT (実行時間タイムアウト)。	FINISHED
MaxAlertTimes	integer	任意	アラートの最大数。最小値: 1。最大値: 10。デフォルト値: 3。	2
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: テキストメッセージ。 SMS アラートをサポートするリージョンは、シンガポール、マレーシア (クアラルンプール)、ドイツ (フランクフルト) です。 Webhooks (WeCom または Lark チャットボット)。このアラートメソッドは、Webhooks パラメーターが設定された後にのみ効果があります。 DINGROBOTS: DingTalk チャットボット。複数のアラートメソッドはコンマ (,) で区切ります。	SMS,MAIL
AlertTargets	string	任意	AlertUnit (アラート受信者) が OWNER (ノードオーナー) にセットされている場合、空の値を渡します。 AlertUnit (アラート受信者) が OTHER (指定ユーザー) にセットされている場合、指定ユーザーの Alibaba Cloud UID を渡します。複数の Alibaba Cloud UID はコンマ (,) で区切ります。UID の最大値は 10 個です。	9527952795279527
RobotUrls	string	任意	DingTalk チャットボットの Webhook URL。複数の Webhook URL はコンマ (,) で区切ります。	https://oapi.dingtalk.com/robot/send?access_token=******************************
Webhooks	string	任意	WeCom または Lark チャットボットの Webhook URL。複数の Webhook URL はコンマ (,) で区切ります。alertMethods パラメーターには WEBHOOKS アラートメソッドを含める必要があります。 DataWorks Enterprise エディションのみサポートされています。利用可能なリージョン: 中国 (上海)、中国 (成都)、中国 (張家口)、中国 (北京)、中国 (杭州)、中国 (深セン)、香港 (中国)、ドイツ (フランクフルト)、シンガポール。	https://open.feishu.cn/open-apis/bot/v2/hook/*******

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
HttpStatusCode	integer	HTTP 状態コード。	200
Data	integer	カスタム監視ルール作成後に返されるカスタムルールの ID。	1234
ErrorMessage	string	エラーメッセージ。	指定されたパラメーターが有効ではありません。
RequestId	string	リクエストの一意の ID。この ID を使用して問題のトラブルシューティングを行うことができます。	0000-ABCD-EFG****
Success	boolean	リクエストが成功したかどうかを示します。	true
ErrorCode	string	エラーコード。	1031203110005

例

成功レスポンス

JSONJSON

{
  "HttpStatusCode": 200,
  "Data": 1234,
  "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.NoProject	You have not joined any project.
500	Invalid.Wkbench.NodeNotExist	The node does not exist.
500	Invalid.Wkbench.BaselineNotExist	The baseline does not exist.
500	Forbidden.Wkbench.RemindOverlimit	The maximum number of reminders is exceeded.
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.
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.

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

変更履歴

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