Virtual Server Image Export Function

This function allows you to specify a virtual server image created from a virtual server, and make a request to the system for export processing. Further, there is a function for checking the status of the requested export process.

Virtual Server Image Export Request Function

To request the export of a virtual server image, specify the following items. If the request is successful, an export ID is issued.

Table 1. Exporting a Virtual Server Image (List of Items)
Item Description Required
Image ID Specify the image ID assigned to the export source virtual server.
Export Destination Container for Object Storage

Specify the object storage container where exported virtual server images are stored. Use the following format:

/v1/AUTH_<Project ID>/<Container Name>
Note:
  • Image IDs other than for projects registered by the user operating this function cannot be specified.
  • You cannot specify the same image ID and the same export destination object storage container when making multiple export requests.
  • If image files (including separated files) with image names identical to the ones set for the image ID already exist in the object storage container that is the export destination, an export request is not possible.

Acquire Export Status List Function

This function acquires a list of virtual server image export processing that can be referenced in the project scope of the token. You can specify the following items and make changes to the range of acquisition.

Table 2. List of Virtual Server Image Export Statuses (List of Setting Items)
Item Description Required
Start Position

Specify the first index where list acquisition starts.

Tip: If this setting is omitted, the most recently requested export process is returned.
 
Number Acquired

Specify the number of records acquired in the list.

Tip: If this setting is omitted, all export processes are returned. (Maximum 200 records)
 

You can also acquire basic status information for each export process.

  • succeeded

    This status indicates that the export process was completed successfully.

  • failed

    This status indicates that the export process failed.

  • processing

    This status indicates that the export is being processed.

  • queued

    This status indicates that the export process is queued.

  • canceling

    This status indicates that the export is being canceled.

  • canceled

    This status indicates that the export has been canceled.

Acquire Export Status Function

You can specify an export ID and acquire detailed information regarding the export processing status for a single virtual server image export process.

  • Information about the status of the export process
  • Progress rate (from 0 to 100%)
  • Information about the settings when the export process was requested
  • Date/time when the export process request was received

Cancel In-Progress Export Process Function

You can specify an export ID and request the cancellation of a single virtual server image export process.

Note:
  • Cancellation can be requested only if the status of the export process is incomplete.
  • You cannot register multiple cancellation requests for the same export ID.
  • Once a cancellation request has been registered, it cannot be canceled.

You can use the Acquire Export Status function to check the cancel status of an export process. However, this function operates as indicated below, depending on the status and progress rate of the export process.

Table 3. Cancel Request Status and Estimated Standby Time until Cancellation is Completed
Cancel Request Status Estimated Standby Time until Cancellation is Completed
Status: queued 5 minutes

Status: processing

Progress rate: 0 - 10

20 minutes

Status: processing

Progress rate: 11 - 40

Varies based on image size (approximately 6 hours for 300 GB)

Tip: Canceled when the progress rate reaches 40.

Status: processing

Progress rate: 41 - 70

Varies based on image size (approximately 1 hour for 300 GB)

Tip: Canceled when the progress rate reaches 70.

Status: processing

Progress rate: 71 - 95

Varies based on image size (approximately 2 hours for 300 GB)

Tip: Canceled when the progress rate reaches 95.