Retrieve image export status

URL

/v1/imageexport/{export_id}/status

Note: {export_id} is export process ID that is returned from image export API.

Method

GET

Request header

Refer to "Request headers" for details on the request headers of this API.

Table 1. Request headers
Request header Value Description
X-Auth-Token String Tokens that were retrieved using the Identity service.

Request body

This API does not accept request parameters. Any content specified for the request body will be ignored.

Response body

Refer to "Response parameters", "Response parameters when export fails", "Detailed error message list when export fails" and "Response parameters when an error occurs" for details on the response parameters of this API. Each parameter is output in JSON format in the response body.

If export_status is "succeeded" or "processing", the content of "Response parameters" is returned.

If export_status is "failed", the content of "Response parameters", "Response parameters when export fails" and "Detailed error message list when export fails" is returned.

If API "failed", the content of "Response parameters when an error occurs" is returned. Refer to "Detailed error information list" for details on error information returned when an error occurs.

Table 2. Response parameters
Parameter Value Description
export_status String Status of the export process. One of the following is returned.

keyword
Description
succeeded:
Indicates that the export process was completed successfully.
failed:
Indicates that the export process failed.
processing:
Indicates that the export process is in progress.
queued:
Indicates that an export process item is waiting to start.
cancelling:
Indicates that cancellation of the export process is still in progress.
canceled:
Indicates that an export process is canceled.
Status might repeat the state of processing and queued.
progress int Progress status of the export process. Value from 0 to 100.
image_id String ID allocated to the target image of export.
image_name String Name of the target image of export.
storage_container String URL path of the object storage exported image is stored.
request_time String Acceptance date of export processing.

Table 3. Response parameters when export fails
Parameter Value Description
error_message String Detailed error message.

Table 4. Detailed error message list when export fails
Messages Cause of the error Action
Specified id is not found. Image of specified ID does not exist. Check existence of the image of the specified ID.
Specified id is not valid image. Image of specified ID is not valid for export process. Check if the image of specified ID is the target image to export.
Export process has stopped unexpectedly. Export process has stopped. Contact support.
Cancel process has stopped unexpectedly. Cancel process has stopped. Contact support.
Export process takes too long time. Export process has not completed for 7 days after export started. Contact support.
VMexport process is failed (Subsidiary information) In case subsidiary information is "fail to download image" or "fail to upload image". Re-execute the image export API. When a same massage is returned, contact support.
Other than above. Contact support.

Table 5. Response parameters when an error occurs
Parameter Value Description
error_code String Detailed error code.
error_message String Detailed error message.

Table 6. Detailed error information list
Status code Detailed error code Detailed error message Action
403 40301 You cannot execute this API. Check with the Administrator about your account privileges.
404 40401 Invalid export_id. Modify the request URL.
500 50001 Internal server error. Contact support.
500 50002 Internal server error. Contact support.

Status code

Refer to "Status codes" for details on the status codes returned by this API.

Table 7. Status codes
Status code Description
200 Indicates that retrieval of the image export status was successful.
401 Indicates an invalid token.
403 Indicates that retrieval of the image export status execution privileges do not exist.
404 Indicates that export_id specified in URL is invalid.

The status is stored for 7 days after export completion. This status code is returned when the API is run after this period.
500 Retrieval of the image export status failed by internal error.

Example response body

An example response body is shown below.


       {
        "export_status":"succeeded",
        "progress":100,",
        "image_id":"14294f46-d9fe-45bb-ba5f-0b93a69c4416",
        "image_name":"CentOS",
        "storage_container":"/v1/AUTH_100f1c092038413a8dd6771a455b17f5/test_container",
        "request_time":"2016-04-22T00:10:24Z"
       }