イメージエクスポート中止

URL

/v1/imageexport/{export_id}/cancel

※{export_id}はイメージエクスポートAPIが返却するエクスポート処理のID。

POST

本APIが受け取るリクエストヘッダーの一覧をリクエストヘッダー一覧に示す。

表 1. リクエストヘッダー一覧
リクエストヘッダー名	値	説明
X-Auth-Token	String	Identityサービスを使用して取得したトークン。

本APIはリクエストボディを受け取らない。指定した場合は無視される。

本APIは成功時にレスポンスボディを返却しない。失敗時は失敗時のレスポンスパラメーター一覧のパラメーターがJSON形式のレスポンスボディで返却される。失敗時の詳細エラー情報一覧を詳細エラー情報一覧に示す。

表 2. 失敗時のレスポンスパラメーター一覧
パラメーター名	値	説明
error_code	String	詳細エラーコード。
error_message	String	詳細エラーメッセージ。

表 3. 詳細エラー情報一覧
ステータスコード	詳細エラーコード	詳細エラーメッセージ	対処方法
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.	サポートに連絡する。

本APIが返却するステータスコードの一覧をステータスコード一覧に示す。

表 4. ステータスコード一覧
ステータスコード	説明
200	イメージエクスポート中止処理が正常に開始したことを示す。
400	リクエストが不正であること（同一のexport_idに対する中止要求を受付済みであること）を示す。
401	トークンが不正であることを示す。
403	イメージエクスポート中止APIの実行権限がないことを示す。
404	URLで指定したexport_idが不正であることを示す。
405	不正なメソッドによるアクセスであることを示す。
500	内部エラーによりイメージエクスポート中止処理が失敗したことを示す。