List image registration status

URL

/v1/imageimport{?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.

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 on error information returned when an error occurs.

Table 3. Response parameters
Parameter		Value	Description
imports		Array	The route element of a virtual server import process list. Process information matching the project ID of the specified token is returned as an array element. Up to 100 elements are returned, by request order, starting from the newest.
	import_id	String	ID of the import process.
	import_status	String	Status of the import process. One of the following is returned. keyword Description succeeded: Indicates that the import process was completed successfully. failed: Indicates that the import process failed. processing: Indicates that the import process is in progress. queued: Indicates that the import process is waiting to start.
	status	String	URL for retrieving the registration status.

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

Table 5. Detailed error information list
Status code	Detailed error code	Detailed error message	Action
400	40035	Query parameter 'start' has invalid value.	Modify the request content.
400	40036	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 virtual server import process status was successful.
400	Indicates an invalid request.
401	Indicates an invalid token.
403	Indicates that the virtual server import execution privileges do not exist.
500	Indicates that retrieval of the virtual server import process list failed due to an error.

Example response body

An example response body is shown below.


{"imports":[{"import_id":"6bf65660-70ee-4a75-b61a-36ac040c289c","import_status":"succeeded","status":"/v1/imageimport/6bf65660-70ee-4a75-b61a-36ac040c289c/status"}]}