ベースラインを更新します。
今すぐお試しください
テスト
RAM 認証
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| BaselineId |
integer |
必須 |
ベースラインの ID です。ID を照会するには、ListBaselines 操作を呼び出します。 |
1000010800007 |
| ProjectId |
integer |
必須 |
ワークスペースの ID です。ID を照会するには、ListBaselines 操作を呼び出します。 |
2043 |
| BaselineName |
string |
任意 |
ベースラインの名前です。 |
BaselineName |
| Owner |
string |
任意 |
ベースラインの所有者が使用する Alibaba Cloud アカウントの ID です。 |
3726346**** |
| Priority |
integer |
任意 |
ベースラインの優先度です。有効な値：{1, 3, 5, 7, 8}。 |
7 |
| NodeIds |
string |
任意 |
ベースライン内のノードの先祖ノードです。先祖ノードはカンマ (,) で区切ります。先祖ノードが多数存在する場合は、ゼロロードノードを作成し、そのゼロロードノードをベースライン内のノードの子孫ノードとして構成することを推奨します。これにより、ノード管理が容易になります。 |
1,2,3 |
| OvertimeSettings |
array<object> |
任意 |
ベースラインのコミット完了時刻の設定項目です。 |
|
|
object |
任意 |
スケジューリング周期です。 |
||
| Cycle |
integer |
任意 |
コミット完了時刻に対応するスケジューリング周期です。日次ベースラインの場合は 1 を指定します。時間次ベースラインの場合は、24 以下の値を指定します。 |
1 |
| Time |
string |
任意 |
hh:mm 形式のコミット完了時刻です。hh の有効範囲：[0, 47]、mm の有効範囲：[0, 59]。 |
00:00 |
| AlertMarginThreshold |
integer |
任意 |
ベースラインのアラートマージンしきい値です。単位：分。 |
30 |
| BaselineType |
string |
任意 |
ベースラインのタイプです。有効な値：DAILY、HOURLY。 |
DAILY |
| Enabled |
boolean |
任意 |
ベースラインを有効化するかどうかを指定します。有効な値：true、false。 |
true |
| AlertEnabled |
boolean |
任意 |
アラート機能を有効化するかどうかを指定します。有効な値：true、false。 |
true |
| AlertSettings |
array<object> |
任意 |
ベースラインのアラート設定です。 |
|
|
array<object> |
任意 |
ベースラインのアラート設定です。 |
||
| AlertType |
string |
任意 |
アラートのタイプです。有効な値：BASELINE、TOPIC。BASELINE はベースラインアラートを示し、TOPIC はイベントアラートを示します。 |
BASELINE |
| AlertMethods |
array |
任意 |
アラート通知方法です。有効な値：MAIL、SMS、PHONE、DINGROBOTS、Webhooks。MAIL はメールによるアラート通知を意味し、SMS はショートメッセージによるアラート通知を意味します。PHONE は電話によるアラート通知を意味しますが、この通知方法は DataWorks Professional Edition 以降のエディションでのみ利用可能です。DINGROBOTS は DingTalk チャットボットを用いたアラート通知を意味し、RobotUrls パラメーターが設定されている場合にのみ利用可能です。Webhooks は WeCom や Lark を用いたアラート通知を意味し、Webhooks パラメーターが設定されている場合にのみ利用可能です。 |
|
|
string |
任意 |
アラート通知方法です。 |
SMS |
|
| SilenceStartTime |
string |
任意 |
サイレンス期間の開始時刻です。 |
00:00:00 |
| SilenceEndTime |
string |
任意 |
サイレンス期間の終了時刻です。 |
00:00:00 |
| AlertInterval |
integer |
任意 |
イベントアラート通知の送信間隔です。単位：分。最小値：5、最大値：1,440。 |
1800 |
| AlertMaximum |
integer |
任意 |
イベントアラート通知の送信回数の上限です。最大値：24。 |
1 |
| DingRobots |
array<object> |
任意 |
DingTalk チャットボットです。 |
|
|
object |
任意 |
DingTalk チャットボットの構成です。 |
||
| WebUrl |
string |
任意 |
DingTalk チャットボットの Webhook URL です。 |
https://oapi.dingtalk.com/robot/send?access_token=xxx |
| AtAll |
boolean |
任意 |
アットマーク (@) を用いて全メンバーをリマインドするかどうかを指定します。有効な値：true、false。 |
false |
| Webhooks |
array |
任意 |
Webhook URL です。 |
|
|
string |
任意 |
WeCom や Lark のチャットボットの Webhook URL です。複数の Webhook URL を指定できます。複数の Webhook URL はカンマ (,) で区切ります。AlertMethods には WEBHOOKS を指定する必要があります。このパラメーターが未定義の場合、指定された Webhook URL はクリアされます。 このパラメーターは DataWorks Enterprise Edition のみでサポートされています。Webhook URL を用いたアラート機能は、以下のリージョンで利用可能です：中国 (上海)、中国 (成都)、中国 (張家口)、中国 (北京)、中国 (杭州)、中国 (深セン)、中国 (香港)、ドイツ (フランクフルト)、シンガポール。 |
https://open.feishu.cn/open-apis/bot/v2/hook/xxx |
|
| TopicTypes |
array |
任意 |
イベントアラートのタイプで、イベント固有の構成です。 |
|
|
string |
任意 |
イベントのタイプです。有効な値：SLOW、ERROR。SLOW は、現在のスケジューリングサイクルにおける特定ノードの実行時間が、過去のスケジューリングサイクルにおける同ノードの平均実行時間と比較して著しく長いことを意味します。ERROR は、特定ノードの実行に失敗したことを意味します。複数のイベントタイプを指定できます。複数のイベントタイプはカンマ (,) で区切ります。 |
SLOW |
|
| BaselineAlertEnabled |
boolean |
任意 |
ベースライン固有のアラート機能を有効化するかどうかを指定します。有効な値：true、false。 |
true |
| AlertRecipientType |
string |
任意 |
アラート受信者のタイプです。有効な値：OWNER、OTHER、SHIFT_SCHEDULE。OWNER はノードのオーナーを意味し、OTHER は指定した担当者を意味します。SHIFT_SCHEDULE は勤怠表に基づく担当者を意味します。 |
OWNER |
| AlertRecipient |
string |
任意 |
アラート受信者の詳細です。AlertRecipientType を OWNER に設定した場合は、このパラメーターを空欄のままにしてください。AlertRecipientType を SHIFT_SCHEDULE に設定した場合は、このパラメーターに勤怠表の名称を指定してください。AlertRecipientType を OTHER に設定した場合は、このパラメーターに担当者の従業員 ID を指定してください。 |
123123 |
| RemoveNodeIds |
string |
任意 |
ベースラインから関連付けを解除するノードの ID です。複数のノード ID を指定できます。複数のノード ID はカンマ (,) で区切ります。 |
123,456 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスパラメーターです。 |
||
| Success |
boolean |
リクエストが成功したかどうかを示します。 |
true |
| ErrorCode |
string |
エラーコードです。 |
401 |
| ErrorMessage |
string |
エラーメッセージです。 |
The specified parameters are invalid. |
| HttpStatusCode |
integer |
HTTP ステータスコードです。 |
200 |
| Data |
boolean |
ベースラインが更新されたかどうかを示します。 |
true |
| RequestId |
string |
リクエスト ID です。 |
6E07E90B-D9BC-5D6B-896A-82BA41A34AE1 |
例
成功レスポンス
JSONJSON
{
"Success": true,
"ErrorCode": "401",
"ErrorMessage": "The specified parameters are invalid.",
"HttpStatusCode": 200,
"Data": true,
"RequestId": "6E07E90B-D9BC-5D6B-896A-82BA41A34AE1"
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。