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

LaunchInstance

post

/20160918/instances

Create a new virtual machine (VM) instance in the specified compartment and availability domain.

When you launch an instance, the instance is automatically attached to a virtual network interface card (VNIC), called the primary VNIC. The VNIC has a private IP address from the subnet's CIDR. A public IP address is also assigned by default if you specify a public subnet. You can also specify private and public IP addresses for this instance. To list public IP addresses that could be assigned, use the ListVnicAttachments operation to get the VNIC OCID for the instance, and then use GetVnic with the VNIC OCID. You can later add secondary VNICs to an instance.

Provide the following LaunchInstanceDetails:

  • compartmentId - The OCID of the compartment where you want to create the instance. See ListCompartments.
  • sourceDetails - The OCID of the image or boot volume that you want to use. The image or boot volume cannot be changed after the instance is created. For an image, use InstanceSourceViaImageDetails to optionally specify the size of the boot volume in gigabytes and the volume performance.
  • shape - The shape (number of OCPUs, amount of memory, maximum number of VNICs, maximum bandwidth) of the instance. See ListShapes. For a Flex shape, see the shapeConfig attribute to customize the number of OCPUs and amount of memory.
  • CreateVnicDetails - The OCID of the subnet, which must be a public subnet if users will connect to this instance using Secure Shell (SSH).
  • metadata - Use the ssh_authorized_keys metadata key to provide a public SSH key if users will connect to this instance using SSH. This key cannot be added or changed after the instance is created.
  • availabilityConfig - Optionally specify the instance recovery action to be taken after a compute node maintenance operation.

    To launch an instance using an instance configuration, see CreateInstanceConfiguration. When you use an instance configuration to create an instance, you can specify blockVolumes and secondaryVnics.

    • Request

    Supported Media Types
    Query Parameters
    Header Parameters
    • 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 ()
    Instance details.
    Root Schema : LaunchInstanceDetails
    Type: object
    Instance launch details. Use the sourceDetails parameter to specify whether a boot volume or an image should be used to launch a new instance.
    Show Source
    • LaunchInstanceAgentConfigDetails
      Configuration options for the Oracle Cloud Agent software running on the instance.
    • LaunchInstanceAvailabilityConfigDetails
      Options for VM migration during infrastructure maintenance events and for defining the availability of a VM instance after a maintenance event that impacts the underlying hardware.
    • Minimum Length: 1
      Maximum Length: 255
      The availability domain of the instance. Oracle Private Cloud Appliance has one availability domain: AD-1
    • Minimum Length: 0
      Maximum Length: 255
      The OCID of the compute capacity reservation this instance is launched under. You can opt out of all default reservations by specifying an empty string as input for this field.
    • Minimum Length: 1
      Maximum Length: 255
      The OCID of the compartment.
    • Minimum Length: 1
      Maximum Length: 255
      The OCID of the compute cluster that the instance will be created in.
    • CreateVnicDetails
      Properties for a VNIC. Use this object when creating the primary VNIC during instance launch or when creating a secondary VNIC.
    • Minimum Length: 1
      Maximum Length: 255
      The OCID of the dedicated VM host.
    • definedTags
      Additional Properties Allowed: additionalProperties
      Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations": {"CostCenter": "42"}}
    • 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
      Additional Properties Allowed: additionalProperties
      Additional 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. The combined size of the metadata and extendedMetadata objects can be a maximum of 32,000 bytes.
    • Minimum Length: 1
      Maximum Length: 255
      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. A hardware failure or Compute node 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. To get a list of fault domains, use the ListFaultDomains operation. Example: FAULT-DOMAIN-1
    • freeformTags
      Additional Properties Allowed: additionalProperties
      Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}
    • Minimum Length: 1
      Maximum Length: 63
      Deprecated. Instead use hostnameLabel in CreateVnicDetails. If you provide both, the values must match.
    • Minimum Length: 1
      Maximum Length: 255
      The OCID of the host reservation that reserves a set of hosts on which a bare metal instance will be launched.
    • Minimum Length: 1
      Maximum Length: 255
      Deprecated. Use sourceDetails with InstanceSourceViaImageDetails source type instead. If you specify values for both, the values must match.
    • InstanceOptions
      Optional mutable instance options
    • Minimum Length: 1
      Maximum Length: 10240
      This is an advanced option. 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. For more control over the boot process, you can provide your own custom iPXE script that runs when the instance boots. Note: The same iPXE script will run every time an instance boots, not only after the initial LaunchInstance call. For more information about iPXE, see http://ipxe.org.
    • Whether to enable in-transit encryption for the data volume's paravirtualized attachment. This field applies to both block volumes and boot volumes. The default value is false.
    • Allowed Values: [ "NATIVE", "EMULATED", "PARAVIRTUALIZED", "CUSTOM" ]
      Specifies the configuration mode for launching virtual machine (VM) instances. See the description of LaunchInstance for descriptions of each configuration mode.
    • LaunchOptions
      Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.
    • metadata
      Additional Properties Allowed: additionalProperties
      Custom metadata key/value pairs that you provide, such as the SSH public key required to connect to the instance.
    • LaunchInstancePlatformConfig
      Discriminator: type
      The platform configuration requested for the instance. If you provide the parameter, the instance is created with the platform configuration that you specify. For any values that you omit, the instance uses the default configuration values for the shape that you specify. If you don't provide the parameter, the default values for the shape are used. Each shape only supports certain configurable values. If the values that you provide are not valid for the specified shape, an error is returned.
    • PreemptibleInstanceConfigDetails
      Configuration options for preemptible instances.
    • Allowed Values: [ "LIVE_MIGRATE", "REBOOT" ]
      The preferred maintenance action for an instance. The default is LIVE_MIGRATE, if live migration is supported.
    • secondaryVnicAttachments
      Secondary VNICS to create and attach as part of the launch instance operation.
    • Minimum Length: 1
      Maximum Length: 255
      The shape of an instance. The shape determines the number of CPUs, amount of memory, and other resources allocated to the instance. Use the ListShapes operation to enumerate all available shapes.
    • LaunchInstanceShapeConfigDetails
      The shape configuration requested for the instance. If the parameter is provided, the instance is created with the resources that you specify. If some properties are missing or the entire parameter is not provided, the instance is created with the default configuration values for the shape that you specify. Each shape only supports certain configurable values. If the values that you provide are not valid for the specified shape, an error is returned.
    • InstanceSourceDetails
      Discriminator: sourceType
    • Minimum Length: 1
      Maximum Length: 255
      Deprecated. Instead use subnetId in CreateVnicDetails. At least one of them is required. If you provide both, the values must match.
    • volumeAttachments
      Volume attachments to create as part of the launch instance operation.
    Nested Schema : LaunchInstanceAgentConfigDetails
    Type: object
    Configuration options for the Oracle Cloud Agent software running on the instance.
    Show Source
    • Default Value: false
      Whether Oracle Cloud Agent can run all the available plugins. This includes the management and monitoring plugins. To get a list of available plugins, use the ListInstanceagentAvailablePlugins operation in the Oracle Cloud Agent API.
    • Default Value: false
      Whether Oracle Cloud Agent can run all the available management plugins. Default value is false (management plugins are enabled). 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.
    • Default Value: false
      Whether Oracle Cloud Agent can gather performance metrics and monitor the instance using the monitoring plugins. Default value is false (monitoring plugins are enabled). 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
      The configuration of plugins associated with this instance.
    Nested Schema : LaunchInstanceAvailabilityConfigDetails
    Type: object
    Options for VM migration during infrastructure maintenance events and for defining the availability of a VM instance after a maintenance event that impacts the underlying hardware.
    Show Source
    • 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.
    • 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.
    Nested Schema : CreateVnicDetails
    Type: object
    Properties for a VNIC. Use this object when creating the primary VNIC during instance launch or when creating a secondary VNIC.
    Show Source
    • Whether the VNIC should be assigned a DNS record. If assignPrivateDnsRecord is set to false, there will be no DNS record registration for the VNIC. If assignPrivateDnsRecord is set to true, the DNS record will be registered. The default value is true. If you specify a hostnameLabel, then assignPrivateDnsRecord must be set to true.
    • Whether the VNIC should be assigned a public IP address (true) or a private IP address (false). If assignPublicIp is not set and prohibitPublicIpOnVnic is true in the Subnet where the VNIC is being created, then no public IP address is assigned. If assignPublicIp is not set and prohibitPublicIpOnVnic is false, then a public IP address is assigned. This public IP address is associated with the primary private IP on the VNIC. If you specify a vlanId, then assignPublicIp must be set to false.
    • definedTags
      Additional Properties Allowed: additionalProperties
      Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations": {"CostCenter": "42"}}
    • Minimum Length: 1
      Maximum Length: 255
      A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    • freeformTags
      Additional Properties Allowed: additionalProperties
      Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}
    • Minimum Length: 1
      Maximum Length: 63
      The hostname for the VNIC's primary private IP. Used for DNS. The value is the hostname portion of the primary private IP's fully qualified domain name (FQDN) (for example, myinstance-1 in FQDN myinstance-1.subnet123.vcn1.example.com). Must be unique across all VNICs in the subnet and comply with [RFC 952](https://tools.ietf.org/html/rfc952) and [RFC 1123](https://tools.ietf.org/html/rfc1123). The value appears in the Vnic object and also the PrivateIp object returned by ListPrivateIps and GetPrivateIp. When launching an instance, use this hostnameLabel instead of the deprecated hostnameLabel in LaunchInstanceDetails. If you provide both, the values must match. If you specify a vlanId, the hostnameLabel cannot be specified. VNICs on a VLAN cannot be assigned a hostname.
    • nsgIds
      Maximum Number of Items: 5
      Unique Items Required: true
      A list of the OCIDs of the network security groups (NSGs) to add the VNIC to. If a vlanId is specified, the nsgIds cannot be specified. The vlanId indicates that the VNIC will belong to a VLAN instead of a subnet. With VLANs, all VNICs in the VLAN belong to the NSGs that are associated with the VLAN.
    • Minimum Length: 1
      Maximum Length: 46
      A private IP address of your choice to assign to the VNIC. Must be an available IP address within the subnet's CIDR. If you don't specify a value, a private IP address is automatically assigned from the subnet. This is the VNIC's primary private IP address. The value appears in the Vnic object and also the PrivateIp object returned by ListPrivateIps and GetPrivateIp. If you specify a vlanId, the privateIp cannot be specified. Example: 10.0.3.3
    • Whether the source/destination check is disabled on the VNIC. Defaults to false, which means the check is performed. If you specify a vlanId, the skipSourceDestCheck cannot be specified because the source/destination check is always disabled for VNICs in a VLAN. Example: true
    • Minimum Length: 1
      Maximum Length: 255
      The OCID of the subnet to create the VNIC in. When launching an instance, use this subnetId instead of the deprecated subnetId in LaunchInstanceDetails. At least one of them is required; if you provide both, the values must match. If you are an Oracle Cloud VMware Solution customer and creating a secondary VNIC in a VLAN instead of a subnet, provide a vlanId instead of a subnetId. If you provide both a vlanId and subnetId, the request fails.
    • Minimum Length: 1
      Maximum Length: 255
      Provide this attribute only if you are an Oracle Cloud VMware Solution customer and creating a secondary VNIC in a VLAN. The value is the OCID of the VLAN. Provide a vlanId instead of a subnetId. If you provide both a vlanId and subnetId, the request fails.
    Nested Schema : definedTags
    Type: object
    Additional Properties Allowed
    Show Source
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations": {"CostCenter": "42"}}
    Nested Schema : extendedMetadata
    Type: object
    Additional Properties Allowed
    Show Source
    Additional 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. The combined size of the metadata and extendedMetadata objects can be a maximum of 32,000 bytes.
    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. Example: {"Department": "Finance"}
    Nested Schema : InstanceOptions
    Type: object
    Optional mutable instance options
    Show Source
    • 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.
    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.
    • Deprecated. Instead use isPvEncryptionInTransitEnabled in LaunchInstanceDetails.
    • 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.
    • 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 : metadata
    Type: object
    Additional Properties Allowed
    Show Source
    Custom metadata key/value pairs that you provide, such as the SSH public key required to connect to the instance.
    Nested Schema : LaunchInstancePlatformConfig
    Type: object
    Discriminator: type
    The platform configuration requested for the instance. If you provide the parameter, the instance is created with the platform configuration that you specify. For any values that you omit, the instance uses the default configuration values for the shape that you specify. If you don't provide the parameter, the default values for the shape are used. Each shape only supports certain configurable values. If the values that you provide are not valid for the specified shape, an error is returned.
    Show Source
    Nested Schema : PreemptibleInstanceConfigDetails
    Type: object
    Configuration options for preemptible instances.
    Show Source
    Nested Schema : secondaryVnicAttachments
    Type: array
    Secondary VNICS to create and attach as part of the launch instance operation.
    Show Source
    Nested Schema : LaunchInstanceShapeConfigDetails
    Type: object
    The shape configuration requested for the instance. If the parameter is provided, the instance is created with the resources that you specify. If some properties are missing or the entire parameter is not provided, the instance is created with the default configuration values for the shape that you specify. Each shape only supports certain configurable values. If the values that you provide are not valid for the specified shape, an error is returned.
    Show Source
    • 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 an entire OCPU. This represents a non-burstable instance.
    • Minimum Value: 0
      The total amount of memory available to the instance, in gigabytes.
    • Minimum Value: 1
      Maximum Value: 4
      The number of NVMe drives to be used for storage. A single drive has 6.8 TB available.
    • Minimum Value: 0
      The total number of OCPUs available to the instance.
    Nested Schema : InstanceSourceDetails
    Type: object
    Discriminator: sourceType
    Show Source
    • The source type for the instance. Use image when specifying the image OCID. Use bootVolume when specifying the boot volume OCID.
    Nested Schema : volumeAttachments
    Type: array
    Volume attachments to create as part of the launch instance operation.
    Show Source
    Nested Schema : pluginsConfig
    Type: array
    Maximum Length: 128
    The configuration of plugins associated with this instance.
    Show Source
    Nested Schema : InstanceAgentPluginConfigDetails
    Type: object
    The configuration of plugins associated with this instance.
    Show Source
    • 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.
    • 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.
    Nested Schema : definedTags
    Type: object
    Additional Properties Allowed
    Show Source
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations": {"CostCenter": "42"}}
    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. Example: {"Department": "Finance"}
    Nested Schema : nsgIds
    Type: array
    Maximum Number of Items: 5
    Unique Items Required: true
    A list of the OCIDs of the network security groups (NSGs) to add the VNIC to. If a vlanId is specified, the nsgIds cannot be specified. The vlanId indicates that the VNIC will belong to a VLAN instead of a subnet. With VLANs, all VNICs in the VLAN belong to the NSGs that are associated with the VLAN.
    Show Source
    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 : 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 : additionalProperties
    Type: object
    Nested Schema : PreemptionAction
    Type: object
    Discriminator: type
    The action to run when the preemptible node is interrupted for eviction.
    Show Source
    • Allowed Values: [ "TERMINATE" ]
      The type of action to run when the instance is interrupted for eviction.
    Nested Schema : AttachVnicDetails
    Type: object
    Show Source
    • CreateVnicDetails
      Properties for a VNIC. Use this object when creating the primary VNIC during instance launch or when creating a secondary VNIC.
    • Minimum Length: 1
      Maximum Length: 255
      A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    • Minimum Length: 1
      Maximum Length: 255
      The OCID of the instance. For the AttachVnic operation, this is a required field for the request.
    • Minimum Value: 0
      Maximum Value: 31
      Which physical network interface card (NIC) the VNIC will use. Defaults to 0. Certain bare metal instance shapes have two active physical NICs (0 and 1). If you add a secondary VNIC to one of these instances, you can specify which NIC the VNIC will use.
    Nested Schema : AttachVolumeDetails
    Type: object
    Discriminator: type
    Show Source
    • CreateVolumeDetails
      The details of the volume to create. For the CreateVolume operation, this field is required in the request.
    • Minimum Length: 3
      Maximum Length: 100
      The device name. To retrieve a list of devices for a given instance, see ListInstanceDevices.
    • Minimum Length: 1
      Maximum Length: 255
      A user-friendly name. Does not need to be unique, and it is changeable. Avoid entering confidential information.
    • Minimum Length: 1
      Maximum Length: 255
      The OCID of the instance. For AttachVolume operation, this is a required field for the request.
    • Whether the attachment was created in read-only mode.
    • Whether the attachment should be created in shareable mode. If an attachment is created in shareable mode, then other instances can attach the same volume, provided that they also create their attachments in shareable mode. Only certain volume types can be attached in shareable mode. Defaults to false if not specified.
    • Minimum Length: 1
      Maximum Length: 255
      The type of volume. The only supported values are "iscsi", "paravirtualized", "service_determined" and "nvme".
    • Minimum Length: 1
      Maximum Length: 255
      The OCID of the volume. If CreateVolumeDetails is specified, this field must be omitted from the request.
    Nested Schema : CreateVolumeDetails
    Type: object
    The details of the volume to create. For the CreateVolume operation, this field is required in the request.
    Show Source
    • autotunePolicies
      Unique Items Required: true
      The list of autotune policies to be enabled for this volume.
    • Minimum Length: 1
      Maximum Length: 255
      The availability domain of the volume, which is AD-1. This parameter is not needed to clone a volume.
    • Minimum Length: 1
      Maximum Length: 255
      If provided, specifies the OCID of the volume backup policy to assign to the newly created volume. If omitted, no policy will be assigned.
    • blockVolumeReplicas
      Maximum Number of Items: 1
      Unique Items Required: true
      The list of block volume replicas to be enabled for this volume in the specified destination availability domains.
    • Minimum Length: 1
      Maximum Length: 255
      The OCID of the compartment that contains the volume.
    • definedTags
      Additional Properties Allowed: additionalProperties
      Defined tags for this resource. Each key is predefined and scoped to a namespace.
    • Minimum Length: 1
      Maximum Length: 255
      A user-friendly name. Does not need to be unique, and it is changeable. Avoid entering confidential information.
    • freeformTags
      Additional Properties Allowed: additionalProperties
      . Each tag is a simple key-value pair with no predefined name, type, or namespace. The volume block size can be set by using the PCA_blocksize free-form tag. The default block size is 8192 bytes. To specify a different block size, specify a value in bytes for the PCA_blocksize tag. Supported values are a power of 2 between 512 bytes and 1 megabyte. The block size cannot be modified once the volume has been created.
    • Specifies whether the auto-tune performance is enabled for this volume. This field is deprecated. Use the DetachedVolumeAutotunePolicy instead to enable the volume for detached autotune.
    • Minimum Length: 1
      Maximum Length: 255
      The OCID of the Key Management key to assign as the master encryption key for the volume.
    • The size of the volume in GBs.
    • The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Use sizeInGBs instead.
    • VolumeSourceDetails
      Discriminator: type
      Specifies the volume source details for a new Block volume. The volume source is either another Block volume in the same Availability Domain or a Block volume backup or a disk image in Object Storage. This is an optional field. If not specified or set to null, the new Block volume will be empty. When specified, the new Block volume will contain data from the source volume or backup.
    • Minimum Length: 1
      Maximum Length: 255
      The OCID of the volume backup from which the data should be restored on the newly created volume. This field is deprecated. Use the sourceDetails field instead to specify the backup for the volume.
    • This is an optional field. This value indicates whether the volume is AD-local or Regional. Oracle Private Cloud Appliance has one region, named pca_name.domain (for example, mypca.example.com), and one availability domain, named AD-1.
    • The flag indicating the given source volumes will be used for producing a thin clone or full clone.
    • The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. Allowed values: 10 - Balanced option, 20 - Higher Performance option. For performance autotune enabled volumes, it would be the Default(Minimum) VPUs/GB.
    Nested Schema : autotunePolicies
    Type: array
    Unique Items Required: true
    The list of autotune policies to be enabled for this volume.
    Show Source
    Nested Schema : blockVolumeReplicas
    Type: array
    Maximum Number of Items: 1
    Unique Items Required: true
    The list of block volume replicas to be enabled for this volume in the specified destination availability domains.
    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
    . Each tag is a simple key-value pair with no predefined name, type, or namespace. The volume block size can be set by using the PCA_blocksize free-form tag. The default block size is 8192 bytes. To specify a different block size, specify a value in bytes for the PCA_blocksize tag. Supported values are a power of 2 between 512 bytes and 1 megabyte. The block size cannot be modified once the volume has been created.
    Nested Schema : VolumeSourceDetails
    Type: object
    Discriminator: type
    Specifies the volume source details for a new Block volume. The volume source is either another Block volume in the same Availability Domain or a Block volume backup or a disk image in Object Storage. This is an optional field. If not specified or set to null, the new Block volume will be empty. When specified, the new Block volume will contain data from the source volume or backup.
    Show Source
    Nested Schema : AutotunePolicy
    Type: object
    Discriminator: autotuneType
    An autotune policy automatically tunes the volume's performace based on the type of the policy.
    Show Source
    Nested Schema : BlockVolumeReplicaDetails
    Type: object
    Contains the details for the block volume replica
    Show Source
    • Minimum Length: 1
      Maximum Length: 255
      The availability domain of the block volume replica. Example: AD-1
    • Minimum Length: 1
      Maximum Length: 255
      A user-friendly name. Does not need to be unique, and it is changeable. Avoid entering confidential information.
    Nested Schema : additionalProperties
    Type: object
    Additional Properties Allowed
    Show Source
    Key-value pair representing a defined tag key and value, scoped to a namespace.
    Nested Schema : additionalProperties
    Type: object
    The value of the tag. Only the String type is supported.
    Back to Top

    Response

    Supported Media Types

    200 Response

    The instance is being launched.
    Headers
    • For optimistic concurrency control. See if-match.
    • Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
    • The OCID of the work request. Use GetWorkRequest with this OCID to track the status of the request.
    Body ()
    Root Schema : Instance
    Type: object
    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.
    Show Source
    • InstanceAgentConfig
      Configuration options for the Oracle Cloud Agent software running on the instance.
    • InstanceAvailabilityConfig
      Options for defining the availabiity of a VM instance after a maintenance event that impacts the underlying hardware.
    • Minimum Length: 1
      Maximum Length: 255
      The availability domain the instance is running in. Oracle Private Cloud Appliance has one availability domain: AD-1
    • 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.
    • Minimum Length: 1
      Maximum Length: 255
      The OCID of the compartment that contains the instance.
    • Minimum Length: 1
      Maximum Length: 255
      The OCID of dedicated VM host.
    • definedTags
      Additional Properties Allowed: additionalProperties
      Defined tags for this resource. Each key is predefined and scoped to a namespace.
    • 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
      Additional Properties Allowed: additionalProperties
      Additional 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).
    • 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
      Additional Properties Allowed: additionalProperties
      Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}
    • Minimum Length: 1
      Maximum Length: 255
      The OCID of the instance.
    • Minimum Length: 1
      Maximum Length: 255
      Deprecated. Use sourceDetails instead.
    • InstanceOptions
      Optional mutable instance options
    • 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.

    • 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
    Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.
  • Allowed Values: [ "MOVING", "PROVISIONING", "RUNNING", "STARTING", "STOPPING", "STOPPED", "SUSPENDING", "SUSPENDED", "CREATING_IMAGE", "TERMINATING", "TERMINATED" ]
    The current state of the instance.
  • metadata
    Additional Properties Allowed: additionalProperties
    Custom metadata that you provide.
  • PlatformConfig
    Discriminator: type
    The platform configuration for the instance.
  • PreemptibleInstanceConfigDetails
    Configuration options for preemptible instances.
  • 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.
  • 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.
  • 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.
  • InstanceShapeConfig
    The shape configuration for an instance. The shape configuration determines the resources allocated to an instance.
  • InstanceSourceDetails
    Discriminator: sourceType
  • systemTags
    Additional Properties Allowed: additionalProperties
    System tags for this resource. Each key is predefined and scoped to a namespace.
  • 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
  • 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
  • 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
    • Nested Schema : InstanceAgentConfig
    Type: object
    Configuration options for the Oracle Cloud Agent software running on the instance.
    Show Source
    • Default Value: false
      Whether Oracle Cloud Agent can run all of the available plugins. This includes the management and monitoring plugins.
    • 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.
    • 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
      The configuration of plugins associated with this instance.
    Nested Schema : InstanceAvailabilityConfig
    Type: object
    Options for defining the availabiity of a VM instance after a maintenance event that impacts the underlying hardware.
    Show Source
    • 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.
    • 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.
    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 : extendedMetadata
    Type: object
    Additional Properties Allowed
    Show Source
    Additional 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).
    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. Example: {"Department": "Finance"}
    Nested Schema : InstanceOptions
    Type: object
    Optional mutable instance options
    Show Source
    • 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.
    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.
    • Deprecated. Instead use isPvEncryptionInTransitEnabled in LaunchInstanceDetails.
    • 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.
    • 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 : metadata
    Type: object
    Additional Properties Allowed
    Show Source
    Custom metadata that you provide.
    Nested Schema : PlatformConfig
    Type: object
    Discriminator: type
    The platform configuration for the instance.
    Show Source
    Nested Schema : PreemptibleInstanceConfigDetails
    Type: object
    Configuration options for preemptible instances.
    Show Source
    Nested Schema : InstanceShapeConfig
    Type: object
    The shape configuration for an instance. The shape configuration determines the resources allocated to an instance.
    Show Source
    • 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.
    • A short description of the instance's graphics processing unit (GPU). If the instance does not have any GPUs, this field is null.
    • Minimum Value: 0
      The number of GPUs available to the instance.
    • 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.
    • Minimum Value: 0
      The number of local disks available to the instance.
    • 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.
    • Minimum Value: 0
      The maximum number of VNIC attachments for the instance.
    • Minimum Value: 0
      The total amount of memory available to the instance, in gigabytes.
    • Minimum Value: 0
      The networking bandwidth available to the instance, in gigabits per second.
    • Minimum Value: 0
      The total number of OCPUs available to the instance.
    • Minimum Length: 1
      Maximum Length: 255
      A short description of the instance's processor (CPU).
    Nested Schema : InstanceSourceDetails
    Type: object
    Discriminator: sourceType
    Show Source
    • The source type for the instance. Use image when specifying the image OCID. Use bootVolume when specifying the boot volume OCID.
    Nested Schema : systemTags
    Type: object
    Additional Properties Allowed
    Show Source
    System tags for this resource. Each key is predefined and scoped to a namespace.
    Nested Schema : pluginsConfig
    Type: array
    Maximum Length: 128
    The configuration of plugins associated with this instance.
    Show Source
    Nested Schema : InstanceAgentPluginConfigDetails
    Type: object
    The configuration of plugins associated with this instance.
    Show Source
    • 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.
    • 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.
    Nested Schema : additionalProperties
    Type: object
    Additional Properties Allowed
    Show Source
    Key-value pair representing a defined tag key and value, scoped to a namespace.
    Nested Schema : additionalProperties
    Type: object
    The value of the tag. Only the String type is supported.
    Nested Schema : additionalProperties
    Type: object
    Nested Schema : PreemptionAction
    Type: object
    Discriminator: type
    The action to run when the preemptible node is interrupted for eviction.
    Show Source
    • Allowed Values: [ "TERMINATE" ]
      The type of action to run when the instance is interrupted for eviction.
    Nested Schema : additionalProperties
    Type: object
    Additional Properties Allowed
    Show Source
    Key-value pair representing a defined tag key and value, scoped to a namespace.
    Nested Schema : additionalProperties
    Type: object
    The value of the tag. Only the String type is supported.

    400 Response

    Bad Request
    Headers
    • Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
    Body ()
    Root Schema : Error
    Type: object
    The properties that define an error.
    Show Source

    401 Response

    Unauthorized
    Headers
    • Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
    Body ()
    Root Schema : Error
    Type: object
    The properties that define an error.
    Show Source

    404 Response

    Not Found
    Headers
    • Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
    Body ()
    Root Schema : Error
    Type: object
    The properties that define an error.
    Show Source

    409 Response

    Conflict
    Headers
    • Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
    Body ()
    Root Schema : Error
    Type: object
    The properties that define an error.
    Show Source

    500 Response

    Internal Server Error
    Headers
    • Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
    Body ()
    Root Schema : Error
    Type: object
    The properties that define an error.
    Show Source

    Default Response

    An error has occurred.
    Headers
    • Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
    Body ()
    Root Schema : Error
    Type: object
    The properties that define an error.
    Show Source
    Back to Top