List Images

get

/20160918/images

List a subset of images available in the specified compartment, including platform images and custom images. The list of platform images includes the three most recently published versions of each major distribution. The list of images returned is ordered to first show the recent platform images, then all of the custom images.

Note: Platform images are refreshed regularly. When new images are released, older versions are replaced. The images remain available by OCID, but when the platform image is replaced, the image OCIDs are no longer returned as part of the platform image list.

Request

Supported Media Types
Query Parameters
  • Minimum Length: 1
    Maximum Length: 255
    The OCID of the compartment.
  • Minimum Length: 1
    Maximum Length: 255
    A filter to return only resources that match the entire display name given.
  • A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
  • Minimum Value: 1
    Maximum Value: 1000
    For list pagination. The maximum number of results per page, or items to return in a paginated List call. 1 is the minimum, 1000 is the maximum.
    Default Value: 100
  • The image's operating system. Example: Oracle Linux
  • The image's operating system version. Example: 7.9
  • Minimum Length: 1
    Maximum Length: 512
    For list pagination. The value of the opc-next-page response header from the previous List call.
    Default Value: 0
  • Shape name.
  • The optional field to sort the results by.
    Allowed Values: [ "TIMECREATED", "NAME" ]
  • The sort order to use, either ascending (ASC) or descending (DESC).
    Default Value: ASC
    Allowed Values: [ "ASC", "DESC" ]
Back to Top

Response

Supported Media Types

200 Response

The list is being retrieved.
Headers
  • For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
  • 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 : schema
Type: array
Show Source
Nested 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.

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