このドキュメントでは、指定されたタスクを操作する方法について説明します。サポートされている操作は、ロールバック、再試行、キャンセル、およびスキップです。
呼び出しの説明
インターフェース制約
状態が
FAILEDのタスクのみがロールバック、再試行、およびスキップをサポートしています。完了していないタスクのみがキャンセルをサポートしています。
obshell ServerはこのAPIに対してセキュリティ検証を実施します。詳細については APIハイブリッド暗号化 を参照してください。
リクエストパス
POST /api/v1/task/dag/{id}
リクエストパラメータ
パラメータ |
型 |
必須 |
サンプル値 |
説明 |
|---|---|---|---|---|
| operator | string | はい | "ROLLBACK" | タスクの実行操作を指定します。次のような値が設定できます。
|
戻り値
パラメータ |
型 |
説明 |
|---|---|---|
| successful | bool | リクエストが成功したかどうかを示します。 |
| timestamp | time.Time | サーバーがリクエストを完了したタイムスタンプです。 |
| duration | int | サーバーがリクエストを処理した時間（ミリ秒）です。 |
| status | int | HTTPステータスコードに準拠したエンコードです。 |
| 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を呼び出すこともできます。