このドキュメントでは、指定されたタスクを操作する方法について説明します。サポートされる操作には、ロールバック、リトライ、キャンセル、スキップが含まれます。
呼び出しの説明
インターフェース制約
状態が
FAILEDのタスクのみがロールバック、リトライ、スキップをサポートします。完了していないタスクのみがキャンセルをサポートします。
obshell ServerはこのAPIに対してセキュリティ検証を実施します。詳細についてはAPIハイブリッド暗号化を参照してください。
リクエストパス
POST /api/v1/task/dag/{id}
リクエストパラメータ
| パラメータ | タイプ | 必須 | サンプル値 | 説明 |
|---|---|---|---|---|
| operator | string | はい | "ROLLBACK" | タスクの実行操作を指定します。以下の値があります:
|
戻り値
| パラメータ | タイプ | 説明 |
|---|---|---|
| successful | bool | リクエストが成功したかどうかを示します。 |
| timestamp | time.Time | サーバーがリクエストを完了したタイムスタンプです。 |
| duration | int | サーバーがリクエストを処理した時間(ミリ秒)です。 |
| status | int | HTTP Status規格に準拠したエンコードです。 |
| traceId | string | リクエストのトレースIDです。 |
| error | ApiError | リクエストによって生成されたエラーで、以下の情報が含まれます:
|
例
リクエスト例
POST 10.10.10.1:2886/api/v1/task/22130706433028869
{
"operator": "ROLLBACK"
}
22130706433028869は、すでに失敗したInitialize clusterタスクの汎用的なIDです。
返却例
例では、操作リクエストが成功した結果が返されていますが、タスクの操作結果は不明であり、タスクのクエリを通じて取得する必要があります。
{
"successful": true,
"timestamp": "2024-01-10T14:44:28.366402356+08:00",
"duration": 1,
"status": 200,
"traceId": "7e77b2ba9ee2fa66"
}
関連ドキュメント
コマンドラインからAPIインターフェースを呼び出す以外に、SDKメソッドを使用してAPIを呼び出すこともできます。