ワークスペースリソースタスクのキャンセル¶
POST /api/v1/workspace/resource/cancel
概要¶
現在のワークスペースで自身が開始したリソース処理タスクのキャンセルをリクエストします。
呼び出し前の準備と使用手順¶
現在の Key には workspace.setManage が必要です。タスクは現在のワークスペースおよび作成元 Key のリソース UUID にのみ属します。同じワークスペース内の別の Key は、同じロールであってもそのタスクを読み取ったりキャンセルしたりできません。同じ Key をローテーションしてもリソース UUID は保持されるため、taskId と API Key の値を混同しないでください。
存在するタスクキャッシュの status のみを cancel に変更し、バックエンドはリソースモジュールの境界で協調的にチェックします。実行中の個別操作を強制終了せず、コミット済みのリソースや書き込み済みファイルを取り消しません。また、後続のすべての副作用を阻止することも保証しません。タスクキャッシュが完全に存在しない場合でも status=cancel を返しますが、実際のタスクヒット数はありません。
完了済みのタスクも cancel とマークされる場合があります。ワーカースレッドとキャンセルは競合する可能性があり、その後の状態は ok/error に変わる可能性があります。このレスポンスだけでキャンセル済みまたはロールバック済みであることを証明することはできません。呼び出し後も同じ Key で進捗を照会し、対象リソースを確認してください。特に recover インポートで一部が既に保存されている場合に重要です。このエントリポイントは元の業務データを削除しません。エクスポートファイルが公開済みかどうかは読み戻して確認する必要があります。
キャンセルまたは中断後、その後 noJsonDataError や空の成功カウントが返されたとしても、以前のモジュールで既に保存されている可能性があります。このローカライズされたメッセージは、書き込みがなかったことを証明できません。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Body リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| taskId | string | Y | 必須の空でないタスクID。作成時の同一ワークスペース・同一KeyリソースIDを使用する必要があり、ファイル名ではありません。 null の許可: False 例: resource_task_example取得または入力方法: リソースのエクスポートタスクまたはリソースパッケージのインポートのレスポンス content.taskId から取得します。 |
パラメータの補足説明¶
1. インターフェースの用途
実行中のワークスペースリソースのインポートまたはエクスポートタスクをキャンセルします。
2. 使用方法
インポート/エクスポートインターフェースで取得した taskId を渡す必要があります。
キャンセルリクエストの送信に成功すると、インターフェースは次を返します:
説明:
- この戻り値は、タスクがキャンセルとしてマークされたことを示します
- 具体的なタスクの最終状態は、引き続きタスク状態インターフェースで確認できます
3. 注意事項
- 実行完了済みのタスクは元に戻せません
- 一部が正常に実行されたインポートタスクでは、書き込み済みデータが自動的にロールバックされることはありません
- キャンセルが有効かどうかを確認する必要がある場合は、引き続きタスク状態インターフェースをポーリングしてください
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/workspace/resource/cancel' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"taskId":"resource_task_example"}'
レスポンス¶
HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content.status | string | 固定で cancel。キャンセルリクエストの処理が完了したことのみを示し、一致するタスクがない場合があります。 |
| content.declaration | object | 現在のワークスペースの共通宣言。 |
{
"code": 200,
"content": {
"status": "cancel",
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、および共通リクエストエラーについては、共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反している | パラメータの解析に失敗しました | パラメータの位置、フィールド名、型、値を確認してください。 |
| 400 | ft.RequestJsonFormatError | リクエスト JSON の構文が無効 | リクエスト JSON の形式エラー | content.reason、line、column に従って JSON を修正してください。 |
| 400 | ft.JsonFormatError | JSON のトップレベルがオブジェクトではありません | 一部の json ファイルの形式エラー | taskId を含むオブジェクトを送信してください。 |
| 403 | ft.Forbidden | 存在するタスクが現在のワークスペースまたは現在の作成元 Key に属していない、あるいは長タスクの状態キャッシュ再構築に帰属情報がない | 操作権限がありません | 元のワークスペースと元の作成元 Key を使用し、異なる ID でキャンセルしないでください。ID が正しいのに 403 が返る場合は、taskId を保持したまま管理者に長タスクのキャッシュとログを確認してもらってください。 |
| 500 | ft.InternalServerError | タスクキャッシュ/キュー、ファイルシステム、データベース、または未処理のタスク状態/JSON 処理に失敗 | 内部エラー | まず同じワークスペースと同じ Key でタスクおよびリソースの現在の状態を照会し、キューに登録済みか、一部保存済みかを確認してから再試行してください。むやみにインポートを繰り返したり、上書きしたりしないでください。 |