Retrieve the status of the image export list

URL

/v1/imageexport{?start, limit}

Refer to "Query parameters" for details on the query parameters of this API.

Table 1. Query parameters
Parameter Value Description
start (optional) int Specifies the index of the first item to retrieve. If omitted, the most recent import will be used.
limit (optional) int Specifies the number of images to retrieve. If omitted, all process information corresponding to the specified token will be returned (maximum 200).

Note: The number more than 200 can be specified.

Method

GET

Request header

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

Table 2. 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" 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. Refer to "Detailed error information list" for details when it failed.

Table 3. Response parameters
Parameter Value Description
exports Array List of processing status of export of image of each export_id in the same project. Up to 200 elements are returned, by request order from the new request.
export_id String ID of the export process.
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.
status String URL path to retrieve the export status.
image_id String ID allocated to the target image of export.
request_time String Acceptance date of export processing.

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

Table 5. Detailed error information list
Status code Detailed error code Detailed error message Action
400 40013 Query parameter 'start' has invalid value. Modify the request content.
400 40014 Query parameter 'limit' has invalid value. Modify the request content.
403 40301 You cannot execute this API. Check with the Administrator about your account privileges.
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 6. Status codes
Status code Description
200 Indicates that retrieval of the image export status list was successful.
400 Indicates an invalid request.
401 Indicates an invalid token.
403 Indicates that the virtual server export execution privileges do not exist.
405 Indicates an access by an invalid method.
500 Retrieval of the image export status list failed by internal error.

Example response body

An example response body is shown below.


       {
        "exports":[
         {
          "export_id":"6bf65660-70ee-4a75-b61a-36ac040c289c",
          "export_status":"succeeded",
          "status":"/v1/imageexport/6bf65660-70ee-4a75-b61a-36ac040c289c/status",
          "image_id":"ce050928-bdc2-4c15-95dc-be6fbc7d6d83",
          "request_time":"2016-04-25T00:10:24Z"
         },
         {
          "export_id":"c6cb3e62-9b4c-4cd0-971d-2b43a63196bb",
          "export_status":"failed",
          "status":"/v1/imageexport/c6cb3e62-9b4c-4cd0-971d-2b43a63196bb/status",
          "image_id":"944997d2-0b74-11e6-a963-000c29a90136",
          "request_time":"2016-04-22T00:10:24Z"
         }
        ]
       }