Cancel image export#
イメージエクスポートを中止します。
APIエンドポイント#
| リージョン | APIエンドポイント |
|---|---|
| 西日本リージョン3の場合 | https://import-export.jp-west-3.cloud.global.fujitsu.com |
| 東日本リージョン3の場合 | https://import-export.jp-east-3.cloud.global.fujitsu.com |
HTTPメソッドとURI#
POST
/v1/imageexport/{export_id}/cancel
HTTPステータスコード#
正常時：200
エラー時：400, 401, 403, 404, 405, 500
リクエストパラメータの説明#
| 名前 | In | Type | デフォルト値 /必須指定 |
Description |
|---|---|---|---|---|
| X-Auth-Token | header | string | 必須 | Identityサービスを使用して取得したトークン |
| export_id | path | string | 必須 | イメージエクスポートAPIが返却するエクスポート処理のID |
レスポンスボディの説明#
本APIは成功時にレスポンスボディを返却しません。失敗時は失敗時のレスポンスパラメーター一覧のパラメーターがJSON形式のレスポンスボディで返却されます。失敗時の詳細エラー情報一覧を詳細エラー情報一覧に示します。
表 1. 失敗時のレスポンスパラメーター一覧
| パラメーター名 | 値 | 説明 |
|---|---|---|
| error_code | string | 詳細エラーコード |
| error_message | string | 詳細エラーメッセージ |
表 2. 詳細エラー情報一覧
| ステータスコード | 詳細エラーコード | 詳細エラーメッセージ | 対処方法 |
|---|---|---|---|
| 400 | 40010 | Export_id is already accepted cancelling. | 既に中止要求が受付けられているため、再度行う必要はありません。 |
| 403 | 40301 | You cannot execute this API. | アカウントの権限を管理者に確認します。 |
| 404 | 40401 | Invalid export_id. | リクエストのURLを修正します。 |
| 404 | 40402 | Export_id was already finished. | 既にエクスポートが完了しているため、再度行う必要はありません。 |
| 500 | 50001 | Internal server error. | サポートに連絡してください。 |
| 500 | 50002 | Internal server error. | サポートに連絡してください。 |