このドキュメントでは、指定されたタスクを操作する方法について説明します。サポートされている操作は、ロールバック、リトライ、キャンセル、スキップです。
呼び出しの説明
インターフェース制約
状態が
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 | リクエストのTrace IDです。 |
| error | ApiError | リクエストで発生したErrorで、以下の情報が含まれます:
|
例
リクエスト例
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を呼び出すこともできます。