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
- application/json
Query Parameters
-
compartmentId(required): string
Minimum Length:
1
Maximum Length:255
The OCID of the compartment. -
displayName: string
Minimum Length:
1
Maximum Length:255
A filter to return only resources that match the entire display name given. -
lifecycleState: string
A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
-
limit: integer
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
-
operatingSystem: string
The image's operating system. Example: Oracle Linux
-
operatingSystemVersion: string
The image's operating system version. Example: 7.9
-
page: string
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: string
Shape name.
-
sortBy: string
The optional field to sort the results by.Allowed Values:
[ "TIMECREATED", "NAME" ]
-
sortOrder: string
The sort order to use, either ascending (ASC) or descending (DESC).Default Value:
ASC
Allowed Values:[ "ASC", "DESC" ]
Response
Supported Media Types
- application/json
200 Response
The list is being retrieved.
Headers
-
opc-next-page: string
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).
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Root Schema : schema
Type:
Show Source
array
-
Array of:
object Image
A boot disk image for launching an instance. Avoid entering confidential information.
Nested Schema : Image
Type:
object
A boot disk image for launching an instance. Avoid entering confidential information.
Show Source
-
agentFeatures:
object InstanceAgentFeatures
Oracle Cloud Agent features supported on the image.
-
baseImageId:
string
Minimum Length:
1
Maximum Length:255
The OCID of the image originally used to launch the instance. -
billableSizeInGBs:
integer(int64)
The size of the internal storage for this image that is subject to billing (1 GB = 1,073,741,824 bytes). Example: 100
-
compartmentId(required):
string
Minimum Length:
1
Maximum Length:255
The OCID of the compartment containing the instance you want to use as the basis for the image. -
createImageAllowed(required):
boolean
Whether instances launched with this image can be used to create new images. For example, you cannot create an image of an Oracle Database instance.
-
definedTags:
object definedTags
Additional Properties Allowed: additionalPropertiesDefined tags for this resource. Each key is predefined and scoped to a namespace.
-
displayName:
string
Minimum Length:
1
Maximum Length:255
A user-friendly name for the image. It does not need to be unique, and it is changeable. Avoid entering confidential information. Do not use a platform image name as a custom image name. -
freeformTags:
object freeformTags
Additional Properties Allowed: additionalPropertiesFree-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
-
id(required):
string
Minimum Length:
1
Maximum Length:255
The OCID of the image. -
imageVolumeDetails:
object ImageVolumeDetails
Describes the Volumes that will be created when an Instance based on this Image is launched.
-
launchMode:
string
Allowed Values:
[ "NATIVE", "EMULATED", "PARAVIRTUALIZED", "VDPA", "CUSTOM" ]
Specifies the configuration mode for launching virtual machine (VM) instances. See the description of LaunchInstace for descriptions of each configuration mode. -
launchOptions:
object LaunchOptions
Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.
-
lifecycleState(required):
string
Allowed Values:
[ "PROVISIONING", "IMPORTING", "AVAILABLE", "EXPORTING", "DISABLED", "DELETED" ]
-
listingType:
string
Allowed Values:
[ "COMMUNITY", "NONE" ]
The listing type of the image. The default value is "NONE". -
operatingSystem(required):
string
Minimum Length:
1
Maximum Length:255
The image's operating system. Example: Oracle Linux -
operatingSystemVersion(required):
string
Minimum Length:
1
Maximum Length:255
The image's operating system version. Example: 7.9 -
sizeInMBs:
integer(int64)
The boot volume size for an instance launched from this image (1 MB = 1,048,576 bytes). Note this is not the same as the size of the image when it was exported or the actual size of the image. Example: 47694
-
timeCreated(required):
string(date-time)
The date and time the image was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z
Nested Schema : InstanceAgentFeatures
Type:
object
Oracle Cloud Agent features supported on the image.
Show Source
-
isManagementSupported:
boolean
This attribute is not used.
-
isMonitoringSupported:
boolean
This attribute is not used.
Nested Schema : definedTags
Type:
object
Additional Properties Allowed
Show Source
-
object additionalProperties
Additional Properties Allowed: additionalPropertiesKey-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}`
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:
array 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
-
bootVolumeType:
string
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. -
firmware:
string
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. -
isConsistentVolumeNamingEnabled:
boolean
Whether to enable consistent volume naming feature. Defaults to false.
-
isEncryptionInTransitEnabled:
boolean
Specifies whether in-transit encryption is enabled for the data volume's attachment.
-
isPvEncryptionInTransitEnabled:
boolean
Deprecated. Instead use isPvEncryptionInTransitEnabled in LaunchInstanceDetails.
-
networkType:
string
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. -
remoteDataVolumeType:
string
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
-
object additionalProperties
The value of the tag. Only the String type is supported.
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
-
Array of:
object ImageVolume
Describes a volume that will be created and attached when an Image is launched as an Instance.
Nested Schema : ImageVolume
Type:
object
Describes a volume that will be created and attached when an Image is launched as an Instance.
Show Source
-
displayName:
string
A user-friendly description for the Volume, provided by the user.
-
index(required):
integer
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.
-
sizeInMBs:
integer(int64)
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
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
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).
-
message(required):
string
A human-readable error string.
401 Response
Unauthorized
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
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).
-
message(required):
string
A human-readable error string.
404 Response
Not Found
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
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).
-
message(required):
string
A human-readable error string.
500 Response
Internal Server Error
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
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).
-
message(required):
string
A human-readable error string.
Default Response
An error has occurred.
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
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).
-
message(required):
string
A human-readable error string.