ワークスペースリソースタスクのキャンセル¶

POST /api/v1/workspace/resource/cancel

概要¶

ワークスペースのリソースインポート/エクスポートタスクをキャンセルします。

Body リクエストパラメータ¶

パラメータ補足説明¶

1. インターフェースの目的

実行中のワークスペースリソースインポートまたはエクスポートタスクをキャンセルします。

2. 使用上の注意

インポート/エクスポートインターフェースで取得した taskId を渡す必要があります。

キャンセルリクエストが正常に送信されると、インターフェースは次のように返します。

{
  "status": "cancel"
}

説明：

• この返却は、タスクがキャンセルとしてマークされたことを示します。
• 具体的なタスクの最終状態は、引き続きタスクステータスインターフェースで確認できます。

3. 注意事項

1. 実行完了済みのタスクはロールバックできません。
2. 一部成功したインポートタスクは、書き込まれたデータを自動的にロールバックしません。
3. キャンセルが有効になったかどうかを確認するには、引き続きタスクステータスインターフェースをポーリングしてください。

リクエスト例¶

curl 'https://openapi.guance.com/api/v1/workspace/resource/cancel' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"taskId":"task_xxx"}' \
--compressed

レスポンス¶

{
    "code": 200,
    "content": {
        "status": "cancel"
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-XXXX"
}