1. REST API for Oracle Private Cloud Appliance Compute Enclave
  2. Tasks
  3. Compute
  4. Images

Export an Image

post

/20160918/images/{image_id}/actions/export

Export the specified image to the Object Storage service. You can use the Object Storage URL, or the namespace, bucket name, and object name when specifying the location to export to. To perform an image export, you need write access to the Object Storage bucket for the image.

The exportFormat parameter specifies the format to export the image to. The default value is OCI. The following image formats are available:

  • OCI - Oracle Cloud Infrastructure file with a QCOW2 image and Oracle Cloud Infrastructure metadata (.oci). Use this format to export a custom image that you want to import into other tenancies or regions.
  • QCOW2 - QEMU Copy On Write (.qcow2)
  • VDI - Virtual Disk Image (.vdi) for Oracle VM VirtualBox
  • VHD - Virtual Hard Disk (.vhd) for Hyper-V
  • VMDK - Virtual Machine Disk (.vmdk)

    • Request

    Supported Media Types
    Path Parameters
    Header Parameters
    • For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
    • Minimum Length: 1
      Maximum Length: 64
      A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
    Body ()
    Details for the image export.
    Root Schema : ExportImageDetails
    Type: object
    Discriminator: destinationType
    The destination details for the image export. Set destinationType to objectStorageTuple and use ExportImageViaObjectStorageTupleDetails when specifying the namespace, bucket name, and object name. Set destinationType to objectStorageUri and use ExportImageViaObjectStorageUriDetails when specifying the Object Storage URL.
    Show Source
    • The destination type. Use objectStorageTuple when specifying the namespace, bucket name, and object name. Use objectStorageUri when specifying the Object Storage URL.
    • Allowed Values: [ "QCOW2", "VMDK", "OCI", "VHD", "VDI" ]
      The format to export the image to. See the ExportImage description for descriptions of each possible value.
    Back to Top

    Response

    Supported Media Types

    200 Response

    The export is being performed.
    Headers
    • For optimistic concurrency control. See `if-match`.
    • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
    • The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) with this ID to track the status of the request.
    Body ()
    Root Schema : Image
    Type: object
    A boot disk image for launching an instance. Avoid entering confidential information.
    Show Source
    Nested Schema : InstanceAgentFeatures
    Type: object
    Oracle Cloud Agent features supported on the image.
    Show Source
    Nested Schema : definedTags
    Type: object
    Additional Properties Allowed
    Show Source
    Defined tags for this resource. Each key is predefined and scoped to a namespace.
    Nested Schema : freeformTags
    Type: object
    Additional Properties Allowed
    Show Source
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
    Nested Schema : ImageVolumeDetails
    Type: object
    Describes the Volumes that will be created when an Instance based on this Image is launched.
    Show Source
    • dataVolumes
      Maximum Number of Items: 32
      An optional list of dataVolumes that will be defined at Instance creation time. This list will include any additional data volumes to be defined, but will not include the boot volume.
    Nested Schema : LaunchOptions
    Type: object
    Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.
    Show Source
    • Allowed Values: [ "ISCSI", "SCSI", "IDE", "VFIO", "PARAVIRTUALIZED", "NVME" ]
      Emulation type for the boot volume. See the description of LaunchInstance for descriptions of each possible value.
    • Allowed Values: [ "BIOS", "UEFI_64" ]
      Firmware used to boot VM. Select the option that matches your operating system. BIOS - Boot VM using BIOS style firmware. This is compatible with both 32 bit and 64 bit operating systems that boot using MBR style bootloaders. UEFI_64 - Boot VM using UEFI style firmware compatible with 64 bit operating systems. This is the default for platform images.
    • Whether to enable consistent volume naming feature. Defaults to false.
    • Specifies whether in-transit encryption is enabled for the data volume's attachment.
    • Deprecated. Instead use isPvEncryptionInTransitEnabled in LaunchInstanceDetails.
    • Allowed Values: [ "E1000", "VFIO", "PARAVIRTUALIZED", "VDPA" ]
      Emulation type for the physical network interface card (NIC). E1000 - Emulated Gigabit ethernet controller. Compatible with Linux e1000 network driver. VFIO - Direct attached Virtual Function network controller. This is the networking type when you launch an instance using hardware-assisted (SR-IOV) networking. PARAVIRTUALIZED - VM instances launch with paravirtualized devices using VirtIO drivers.
    • Allowed Values: [ "ISCSI", "SCSI", "IDE", "VFIO", "PARAVIRTUALIZED", "NVME" ]
      Emulation type for volume.
    • ISCSI - ISCSI attached block storage device.
    • SCSI - Emulated SCSI disk.
    • IDE - Emulated IDE disk.
    • VFIO - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images.
    • PARAVIRTUALIZED - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images.
    • NVME - NVMe disk.
    Nested Schema : additionalProperties
    Type: object
    Additional Properties Allowed
    Show Source
    Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}`
    Nested Schema : additionalProperties
    Type: object
    The value of the tag. Only the String type is supported.
    Nested Schema : dataVolumes
    Type: array
    Maximum Number of Items: 32
    An optional list of dataVolumes that will be defined at Instance creation time. This list will include any additional data volumes to be defined, but will not include the boot volume.
    Show Source
    Nested Schema : ImageVolume
    Type: object
    Describes a volume that will be created and attached when an Image is launched as an Instance.
    Show Source
    • A user-friendly description for the Volume, provided by the user.
    • The relative index of this volume. This value is used to identity the volume by relative location for updates. The index values will begin at 1.
    • The size of this volume for an instance launched from this image (1 MB = 1,048,576 bytes). Example: `47694`

    400 Response

    Bad Request
    Headers
    • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
    Body ()
    Root Schema : Error
    Type: object
    The properties that define an error.
    Show Source
    • A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
    • A human-readable error string.

    401 Response

    Unauthorized
    Headers
    • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
    Body ()
    Root Schema : Error
    Type: object
    The properties that define an error.
    Show Source
    • A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
    • A human-readable error string.

    404 Response

    Not Found
    Headers
    • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
    Body ()
    Root Schema : Error
    Type: object
    The properties that define an error.
    Show Source
    • A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
    • A human-readable error string.

    409 Response

    Conflict
    Headers
    • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
    Body ()
    Root Schema : Error
    Type: object
    The properties that define an error.
    Show Source
    • A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
    • A human-readable error string.

    412 Response

    Precondition Failed
    Headers
    • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
    Body ()
    Root Schema : Error
    Type: object
    The properties that define an error.
    Show Source
    • A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
    • A human-readable error string.

    500 Response

    Internal Server Error
    Headers
    • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
    Body ()
    Root Schema : Error
    Type: object
    The properties that define an error.
    Show Source
    • A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
    • A human-readable error string.

    Default Response

    An error has occurred.
    Headers
    • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
    Body ()
    Root Schema : Error
    Type: object
    The properties that define an error.
    Show Source
    • A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
    • A human-readable error string.
    Back to Top