ListInstances
/20160918/instances
Request
- application/json
-
availabilityDomain: string
The availability domain of the pod shape.
-
capacityReservationId: string
Minimum Length:
1
Maximum Length:255
The OCID of the compute capacity reservation. -
compartmentId(required): string
Minimum Length:
1
Maximum Length:255
The OCID of the compartment. -
computeClusterId: string
Minimum Length:
1
Maximum Length:255
The OCID of the compute cluster. A compute cluster is a remote direct memory access (RDMA) network group. -
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
-
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:oracle.doceng.json.BetterJsonNull@2c07545f
-
sortBy: string
The optional field to sort the results by.Default Value:
NAME
Allowed Values:[ "ID", "NAME", "TIME_CREATED" ]
-
sortOrder: string
The sort order to use, either ascending (ASC) or descending (DESC).Allowed Values:
[ "ASC", "DESC" ]
Response
- application/json
- application/x-json-stream
200 Response
-
opc-next-page: string
For list pagination. When this header appears in the response, additional pages of results remain. Use this value as the page parameter to get the next page of items.
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
array
-
Array of:
object Instance
A compute host. The image used to launch the instance determines its operating system and other software. The shape specified during the launch process determines the number of CPUs and memory allocated to the instance. Avoid entering confidential information when you supply string values using the API.
object
-
agentConfig:
object InstanceAgentConfig
Configuration options for the Oracle Cloud Agent software running on the instance.
-
availabilityConfig:
object InstanceAvailabilityConfig
Options for defining the availabiity of a VM instance after a maintenance event that impacts the underlying hardware.
-
availabilityDomain(required):
string
Minimum Length:
1
Maximum Length:255
The availability domain the instance is running in. Oracle Private Cloud Appliance has one availability domain: AD-1 -
capacityReservationId:
string
Minimum Length:
0
Maximum Length:255
The OCID of the compute capacity reservation this instance is launched under. When this field contains an empty string or is null, the instance is not currently in a capacity reservation. -
compartmentId(required):
string
Minimum Length:
1
Maximum Length:255
The OCID of the compartment that contains the instance. -
dedicatedVmHostId:
string
Minimum Length:
1
Maximum Length:255
The OCID of dedicated VM host. -
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. Does not need to be unique, and it is changeable. Avoid entering confidential information. -
extendedMetadata:
object extendedMetadata
Additional Properties Allowed: additionalPropertiesAdditional metadata key/value pairs that you provide. They serve the same purpose and functionality as fields in the metadata object. They are distinguished from metadata fields in that these can be nested JSON objects (whereas metadata fields are string/string maps only).
-
faultDomain:
string
Minimum Length:
1
Maximum Length:255
The name of the fault domain the instance is running in. A fault domain is a grouping of hardware and infrastructure within an availability domain. Each availability domain contains three fault domains. Fault domains let you distribute your instances so that they are not on the same physical hardware within a single availability domain. A hardware failure or Compute hardware maintenance that affects one fault domain does not affect instances in other fault domains. If you do not specify the fault domain, the system selects one for you. Example: FAULT-DOMAIN-1 -
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. Example: {"Department": "Finance"}
-
id(required):
string
Minimum Length:
1
Maximum Length:255
The OCID of the instance. -
imageId:
string
Minimum Length:
1
Maximum Length:255
Deprecated. Use sourceDetails instead. -
instanceOptions:
object InstanceOptions
Optional mutable instance options
-
ipxeScript:
string
Minimum Length:
1
Maximum Length:10240
When a bare metal or virtual machine instance boots, the iPXE firmware that runs on the instance is configured to run an iPXE script to continue the boot process. If you want more control over the boot process, you can provide your own custom iPXE script that will run when the instance boots.Note: The same iPXE script will run every time an instance boots, not only after the initial LaunchInstance call.
The default iPXE script connects to the instance's local boot volume over iSCSI and performs a network boot. If you use a custom iPXE script and want to network-boot from the instance's local boot volume over iSCSI the same way as the default iPXE script, use the following iSCSI IP address: 169.254.0.2, and boot volume IQN: iqn.2015-02.oracle.boot. If your instance boot volume type is paravirtualized, the boot volume is attached to the instance through virtio-scsi and no iPXE script is used. If your instance boot volume type is paravirtualized and you use custom iPXE to network boot into your instance, the primary boot volume is attached as a data volume through virtio-scsi drive. For more information about iPXE, see http://ipxe.org.
-
launchMode:
string
Allowed Values:
[ "NATIVE", "EMULATED", "PARAVIRTUALIZED", "CUSTOM" ]
Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are:- NATIVE - VM instances launch with iSCSI boot and VFIO devices. The default value for platform images.
- EMULATED - VM instances launch with emulated devices, such as the E1000 network driver and emulated SCSI disk controller.
- PARAVIRTUALIZED - VM instances launch with paravirtualized devices using VirtIO drivers.
- CUSTOM - VM instances launch with custom configuration settings specified in the LaunchOptions parameter.
-
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:
[ "MOVING", "PROVISIONING", "RUNNING", "STARTING", "STOPPING", "STOPPED", "SUSPENDING", "SUSPENDED", "CREATING_IMAGE", "TERMINATING", "TERMINATED" ]
The current state of the instance. -
metadata:
object metadata
Additional Properties Allowed: additionalPropertiesCustom metadata that you provide.
-
platformConfig:
object PlatformConfig
Discriminator:
type
The platform configuration for the instance. -
preemptibleInstanceConfig:
object PreemptibleInstanceConfigDetails
Configuration options for preemptible instances.
-
preferredMaintenanceAction:
string
Allowed Values:
[ "LIVE_MIGRATE", "REBOOT" ]
The preferred maintenance action for an instance. LIVE_MIGRATE - Run maintenance using a live migration. REBOOT - Run maintenance using a reboot. -
region(required):
string
Minimum Length:
1
Maximum Length:255
The region that contains the availability domain the instance is running in. For Oracle Private Cloud Appliance, the region name is pca_name.domain. Example: mypca.example.com. The region contains one availability domain, which is named AD-1. -
shape(required):
string
Minimum Length:
1
Maximum Length:255
The shape of the instance. The shape determines the number of CPUs and the amount of memory allocated to the instance. You can enumerate all available shapes by calling ListShapes. -
shapeConfig:
object InstanceShapeConfig
The shape configuration for an instance. The shape configuration determines the resources allocated to an instance.
-
sourceDetails:
object InstanceSourceDetails
Discriminator:
sourceType
-
systemTags:
object systemTags
Additional Properties Allowed: additionalPropertiesSystem tags for this resource. Each key is predefined and scoped to a namespace.
-
timeCreated(required):
string(date-time)
The date and time the instance was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z
-
timeMaintenanceRebootDue:
string(date-time)
The date and time the instance is expected to be stopped / started, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). After that time if instance hasn't been rebooted, Oracle will reboot the instance within 24 hours of the due time. Regardless of how the instance was stopped, the flag will be reset to empty as soon as instance reaches Stopped state. Example: 2018-05-25T21:10:29.600Z
-
timeStopScheduled:
string(date-time)
The date and time the instance is scheduled to be stopped. After that time if instance hasn't been stopped or terminated, Oracle will stop the instance automatically. Regardless of how the instance was stopped, the flag will be reset to empty as soon as instance reaches Stopped state. Example: 2018-05-25T21:10:29.600Z
object
-
areAllPluginsDisabled:
boolean
Default Value:
false
Whether Oracle Cloud Agent can run all of the available plugins. This includes the management and monitoring plugins. -
isManagementDisabled:
boolean
Default Value:
false
Whether Oracle Cloud Agent can run all the available management plugins. These are the management plugins: OS Management Service Agent and Compute Instance Run Command. The management plugins are controlled by this parameter and by the per-plugin configuration in the pluginsConfig object. - If isManagementDisabled is true, all of the management plugins are disabled, regardless of the per-plugin configuration. - If isManagementDisabled is false, all of the management plugins are enabled. You can optionally disable individual management plugins by providing a value in the pluginsConfig object. -
isMonitoringDisabled:
boolean
Default Value:
false
Whether Oracle Cloud Agent can gather performance metrics and monitor the instance using the monitoring plugins. These are the monitoring plugins: Compute Instance Monitoring and Custom Logs Monitoring. The monitoring plugins are controlled by this parameter and by the per-plugin configuration in the pluginsConfig object. - If isMonitoringDisabled is true, all of the monitoring plugins are disabled, regardless of the per-plugin configuration. - If isMonitoringDisabled is false, all of the monitoring plugins are enabled. You can optionally disable individual monitoring plugins by providing a value in the pluginsConfig object. -
pluginsConfig:
array pluginsConfig
The configuration of plugins associated with this instance.
object
-
isLiveMigrationPreferred:
boolean
Whether to live migrate supported VM instances to a healthy physical VM host without disrupting running instances during infrastructure maintenance events. If null, Oracle chooses the best option for migrating the VM during infrastructure maintenance events.
-
recoveryAction:
string
Default Value:
RESTORE_INSTANCE
Allowed Values:[ "RESTORE_INSTANCE", "STOP_INSTANCE" ]
The lifecycle state for an instance when it is recovered after infrastructure maintenance. RESTORE_INSTANCE - The instance is restored to the lifecycle state it was in before the maintenance event. If the instance was running, it is automatically rebooted. This is the default action when a value is not set. STOP_INSTANCE - The instance is recovered in the stopped state.
object
-
object additionalProperties
Additional Properties Allowed: additionalPropertiesKey-value pair representing a defined tag key and value, scoped to a namespace.
object
object
object
-
areLegacyImdsEndpointsDisabled:
boolean
Whether to disable the legacy (/v1) instance metadata service endpoints. Customers who have migrated to /v2 should set this to true for added security. Default is false.
object
-
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.
-
isPvEncryptionInTransitEnabled:
boolean
Deprecated. Instead use isPvEncryptionInTransitEnabled in LaunchInstanceDetails.
-
networkType:
string
Allowed Values:
[ "E1000", "VFIO", "PARAVIRTUALIZED" ]
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.
object
object
type
-
isMeasuredBootEnabled:
boolean
Default Value:
false
Whether the Measured Boot feature is enabled on the instance. -
isMemoryEncryptionEnabled:
boolean
Default Value:
false
Whether the instance is a confidential instance. If this value is true, the instance is a confidential instance. The default value is false. -
isSecureBootEnabled:
boolean
Default Value:
false
Whether Secure Boot is enabled on the instance. -
isTrustedPlatformModuleEnabled:
boolean
Default Value:
false
Whether the Trusted Platform Module (TPM) is enabled on the instance. -
type(required):
string
Allowed Values:
[ "AMD_MILAN_BM", "AMD_MILAN_BM_GPU", "AMD_ROME_BM", "AMD_ROME_BM_GPU", "INTEL_ICELAKE_BM", "INTEL_SKYLAKE_BM", "AMD_VM", "INTEL_VM" ]
The type of platform being configured.
object
-
preemptionAction(required):
object PreemptionAction
Discriminator:
type
The action to run when the preemptible node is interrupted for eviction.
object
-
baselineOcpuUtilization:
string
Allowed Values:
[ "BASELINE_1_8", "BASELINE_1_2", "BASELINE_1_1" ]
The baseline OCPU utilization for a subcore burstable VM instance. Leave this attribute blank for a non-burstable instance, or explicitly specify non-burstable with BASELINE_1_1. The following values are supported: - BASELINE_1_8 - baseline usage is 1/8 of an OCPU. - BASELINE_1_2 - baseline usage is 1/2 of an OCPU. - BASELINE_1_1 - baseline usage is the entire OCPU. This represents a non-burstable instance. -
gpuDescription:
string
A short description of the instance's graphics processing unit (GPU). If the instance does not have any GPUs, this field is null.
-
gpus:
integer
Minimum Value:
0
The number of GPUs available to the instance. -
localDiskDescription:
string
Minimum Length:
1
Maximum Length:255
A short description of the local disks available to this instance. If the instance does not have any local disks, this field is null. -
localDisks:
integer
Minimum Value:
0
The number of local disks available to the instance. -
localDisksTotalSizeInGBs:
number(float)
Minimum Value:
0
The aggregate size of all local disks, in gigabytes. If the instance does not have any local disks, this field is null. -
maxVnicAttachments:
integer
Minimum Value:
0
The maximum number of VNIC attachments for the instance. -
memoryInGBs:
number(float)
Minimum Value:
0
The total amount of memory available to the instance, in gigabytes. -
networkingBandwidthInGbps:
number(float)
Minimum Value:
0
The networking bandwidth available to the instance, in gigabits per second. -
ocpus:
number(float)
Minimum Value:
0
The total number of OCPUs available to the instance. -
processorDescription:
string
Minimum Length:
1
Maximum Length:255
A short description of the instance's processor (CPU).
object
sourceType
-
sourceType(required):
string
The source type for the instance. Use image when specifying the image OCID. Use bootVolume when specifying the boot volume OCID.
object
-
object additionalProperties
Additional Properties Allowed: additionalPropertiesKey-value pair representing a defined tag key and value, scoped to a namespace.
array
128
-
Array of:
object InstanceAgentPluginConfigDetails
The configuration of plugins associated with this instance.
object
-
desiredState(required):
string
Allowed Values:
[ "ENABLED", "DISABLED" ]
Whether the plugin should be enabled or disabled. To enable the monitoring and management plugins, the isMonitoringDisabled and isManagementDisabled attributes must also be set to false. -
name(required):
string
Minimum Length:
1
Maximum Length:255
The plugin name. To get a list of available plugins, use the ListInstanceagentAvailablePlugins operation in the Oracle Cloud Agent API.
object
-
object additionalProperties
The value of the tag. Only the String type is supported.
object
object
object
type
-
type(required):
string
Allowed Values:
[ "TERMINATE" ]
The type of action to run when the instance is interrupted for eviction.
object
-
object additionalProperties
The value of the tag. Only the String type is supported.
object
400 Response
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
object
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload
401 Response
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
object
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload
404 Response
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
object
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload
500 Response
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
object
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload
Default Response
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
object
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload