Jump to

• Request
• Response

UpdateInstance

put

/20160918/instances/{instance_id}

Update the specified instance. Avoid entering confidential information. Changes to metadata fields will be reflected in the instance metadata service. This might take up to a minute.

Request

Supported Media Types

• application/json

Path Parameters

• instanceId(required): string
  The OCID of the instance.

Header Parameters

• if-match: string
  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
• opc-retry-token: string
  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 ()

Update instance fields.

Root Schema : UpdateInstanceDetails

Type: object

Show Source

• agentConfig: object UpdateInstanceAgentConfigDetails
  Configuration options for the Oracle Cloud Agent software running on the instance.
• availabilityConfig: object UpdateInstanceAvailabilityConfigDetails
  Options for defining the availability of a VM instance after a maintenance event that impacts the underlying hardware, including whether to live migrate supported VM instances when possible without sending a prior customer notification.
• capacityReservationId: string
  Minimum Length: 0

  Maximum Length: 255

  The OCID of the compute capacity reservation this instance is launched under. You can remove the instance from a reservation by specifying an empty string as input for this field.
• definedTags: object definedTags
  Additional Properties Allowed: additionalProperties

  Defined 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: 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 "user_data" field and the "ssh_authorized_keys" field cannot be changed after an instance has launched. Any request that updates, removes, or adds either of these fields will be rejected. You must provide the same values for "user_data" and "ssh_authorized_keys" that already exist on the instance. The combined size of the metadata and extendedMetadata objects can be a maximum of 32,000 bytes.
• faultDomain: string
  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 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. To get a list of fault domains, use the ListFaultDomains operation in the Identity and Access Management Service API. Example: FAULT-DOMAIN-1
• freeformTags: object 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"}
• instanceOptions: object InstanceOptions
  Optional mutable instance options
• instancePoolMetadataActionConfig: object InstancePoolMetadataAction
  Metadata information to attach or detach instance to the instance pool
• launchOptions: object UpdateLaunchOptions
  Options for tuning the compatibility and performance of VM shapes.
• metadata: object metadata
  Additional Properties Allowed: additionalProperties

  Custom metadata key/value string pairs that you provide. Any set of key/value pairs provided here will completely replace the current set of key/value pairs in the metadata field on the instance. The "user_data" field and the "ssh_authorized_keys" field cannot be changed after an instance has launched. Any request that updates, removes, or adds either of these fields will be rejected. You must provide the same values for "user_data" and "ssh_authorized_keys" that already exist on the instance. The combined size of the metadata and extendedMetadata objects can be a maximum of 32,000 bytes.
• preferredMaintenanceAction: string
  Allowed Values: [ "LIVE_MIGRATE", "REBOOT" ]

  The preferred maintenance action for an instance. The default is LIVE_MIGRATE, if live migration is supported. LIVE_MIGRATE - Run maintenance using a live migration. REBOOT - Run maintenance using a reboot.
• shape: 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. For details about the CPUs, memory, and other properties of each shape, see "Compute Shapes" (https://docs.oracle.com/en/engineered-systems/private-cloud-appliance/3.0-latest/concept/concept-standard-shapes.html#standard-shapes). The new shape must be compatible with the image that was used to launch the instance. You can enumerate all available shapes and determine image compatibility by calling ListShapes. If the instance is running when you change the shape, the instance is rebooted.
• shapeConfig: object UpdateInstanceShapeConfigDetails
  The shape configuration requested for the instance. If provided, the instance will be updated with the resources specified. In the case where some properties are missing, the missing values will be set to the default for the provided shape. Each shape only supports certain configurable values. If the shape is provided and the configuration values are invalid for that new shape, an error will be returned. If no shape is provided and the configuration values are invalid for the instance's existing shape, an error will be returned.
• sourceDetails: object UpdateInstanceSourceDetails
  Discriminator: sourceType

  The details for updating the instance source.
• timeMaintenanceRebootDue: string(date-time)
  The date and time the instance is expected to be stopped and restarted, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). If the instance hasn't been rebooted after this date, Oracle reboots the instance within 24 hours of the time and date that maintenance is due. Regardless of how the instance is stopped, this flag is reset to empty as soon as the instance reaches Stopped state. Example: 2018-05-25T21:10:29.600Z

{
    "properties":{
        "capacityReservationId":{
            "description":"The OCID of the compute capacity reservation this instance is launched under. You can remove the instance from a reservation by specifying an empty string as input for this field.",
            "maxLength":"255",
            "minLength":"0",
            "type":"string",
            "x-default-description":"If you specify a reservation OCID, the instance is launched under the associated compute capacity reservation. Using an empty string for this field value causes the instance to be moved out of the capacity reservation. If you do not specify this parameter, the instance is launched under its current capacity reservation."
        },
        "definedTags":{
            "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace.",
            "type":"object",
            "additionalProperties":{
                "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.",
                "type":"object",
                "additionalProperties":{
                    "description":"The value of the tag. Only the String type is supported.",
                    "type":"object"
                }
            }
        },
        "displayName":{
            "description":"A user-friendly name. Does not need to be unique, and it is changeable. Avoid entering confidential information.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "freeformTags":{
            "description":"Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {\"Department\": \"Finance\"} ",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "agentConfig":{
            "$ref":"#/definitions/UpdateInstanceAgentConfigDetails"
        },
        "instancePoolMetadataActionConfig":{
            "$ref":"#/definitions/InstancePoolMetadataAction"
        },
        "metadata":{
            "additionalProperties":{
                "type":"string"
            },
            "description":"Custom metadata key/value string pairs that you provide. Any set of key/value pairs provided here will completely replace the current set of key/value pairs in the metadata field on the instance. The \"user_data\" field and the \"ssh_authorized_keys\" field cannot be changed after an instance has launched. Any request that updates, removes, or adds either of these fields will be rejected. You must provide the same values for \"user_data\" and \"ssh_authorized_keys\" that already exist on the instance. The combined size of the metadata and extendedMetadata objects can be a maximum of 32,000 bytes.",
            "type":"object"
        },
        "extendedMetadata":{
            "type":"object",
            "additionalProperties":{
                "type":"object"
            },
            "description":"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 \"user_data\" field and the \"ssh_authorized_keys\" field cannot be changed after an instance has launched. Any request that updates, removes, or adds either of these fields will be rejected. You must provide the same values for \"user_data\" and \"ssh_authorized_keys\" that already exist on the instance. The combined size of the metadata and extendedMetadata objects can be a maximum of 32,000 bytes."
        },
        "shape":{
            "description":"The shape of the instance. The shape determines the number of CPUs and the amount of memory allocated to the instance. For details about the CPUs, memory, and other properties of each shape, see \"Compute Shapes\" (https://docs.oracle.com/en/engineered-systems/private-cloud-appliance/3.0-latest/concept/concept-standard-shapes.html#standard-shapes). The new shape must be compatible with the image that was used to launch the instance. You can enumerate all available shapes and determine image compatibility by calling ListShapes. If the instance is running when you change the shape, the instance is rebooted.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "shapeConfig":{
            "$ref":"#/definitions/UpdateInstanceShapeConfigDetails"
        },
        "sourceDetails":{
            "$ref":"#/definitions/UpdateInstanceSourceDetails"
        },
        "preferredMaintenanceAction":{
            "description":"The preferred maintenance action for an instance. The default is LIVE_MIGRATE, if live migration is supported. LIVE_MIGRATE - Run maintenance using a live migration. REBOOT - Run maintenance using a reboot.",
            "enum":[
                "LIVE_MIGRATE",
                "REBOOT"
            ],
            "type":"string"
        },
        "instanceOptions":{
            "$ref":"#/definitions/InstanceOptions"
        },
        "faultDomain":{
            "description":"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. To get a list of fault domains, use the ListFaultDomains operation in the Identity and Access Management Service API. Example: FAULT-DOMAIN-1 ",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "launchOptions":{
            "$ref":"#/definitions/UpdateLaunchOptions"
        },
        "availabilityConfig":{
            "$ref":"#/definitions/UpdateInstanceAvailabilityConfigDetails"
        },
        "timeMaintenanceRebootDue":{
            "description":"The date and time the instance is expected to be stopped and restarted, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). If the instance hasn't been rebooted after this date, Oracle reboots the instance within 24 hours of the time and date that maintenance is due. Regardless of how the instance is stopped, this flag is reset to empty as soon as the instance reaches Stopped state. Example: 2018-05-25T21:10:29.600Z ",
            "format":"date-time",
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : UpdateInstanceAgentConfigDetails

Type: object

Configuration options for the Oracle Cloud Agent software running on the instance.

Show Source

• areAllPluginsDisabled: boolean
  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.
• 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.

{
    "description":"Configuration options for the Oracle Cloud Agent software running on the instance.",
    "properties":{
        "isMonitoringDisabled":{
            "description":"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.",
            "type":"boolean",
            "default":false
        },
        "isManagementDisabled":{
            "description":"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.",
            "type":"boolean",
            "default":false
        },
        "areAllPluginsDisabled":{
            "description":"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.",
            "type":"boolean",
            "default":false
        },
        "pluginsConfig":{
            "description":"The configuration of plugins associated with this instance.",
            "type":"array",
            "maxLength":"128",
            "items":{
                "$ref":"#/definitions/InstanceAgentPluginConfigDetails"
            }
        }
    },
    "type":"object"
}

Nested Schema : UpdateInstanceAvailabilityConfigDetails

Type: object

Options for defining the availability of a VM instance after a maintenance event that impacts the underlying hardware, including whether to live migrate supported VM instances when possible without sending a prior customer notification.

Show Source

• 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.

{
    "description":"Options for defining the availability of a VM instance after a maintenance event that impacts the underlying hardware, including whether to live migrate supported VM instances when possible without sending a prior customer notification.",
    "properties":{
        "isLiveMigrationPreferred":{
            "description":"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.",
            "type":"boolean"
        },
        "recoveryAction":{
            "default":"RESTORE_INSTANCE",
            "description":"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.",
            "enum":[
                "RESTORE_INSTANCE",
                "STOP_INSTANCE"
            ],
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : definedTags

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

  Key-value pair representing a defined tag key and value, scoped to a namespace.

{
    "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace.",
    "type":"object",
    "additionalProperties":{
        "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.",
        "type":"object",
        "additionalProperties":{
            "description":"The value of the tag. Only the String type is supported.",
            "type":"object"
        }
    }
}

Defined tags for this resource. Each key is predefined and scoped to a namespace.

Nested Schema : extendedMetadata

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"object"
    },
    "description":"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 \"user_data\" field and the \"ssh_authorized_keys\" field cannot be changed after an instance has launched. Any request that updates, removes, or adds either of these fields will be rejected. You must provide the same values for \"user_data\" and \"ssh_authorized_keys\" that already exist on the instance. The combined size of the metadata and extendedMetadata objects can be a maximum of 32,000 bytes."
}

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 "user_data" field and the "ssh_authorized_keys" field cannot be changed after an instance has launched. Any request that updates, removes, or adds either of these fields will be rejected. You must provide the same values for "user_data" and "ssh_authorized_keys" that already exist on the instance. 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

• string

{
    "description":"Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {\"Department\": \"Finance\"} ",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

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

• 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.

{
    "description":"Optional mutable instance options",
    "properties":{
        "areLegacyImdsEndpointsDisabled":{
            "description":"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.",
            "type":"boolean"
        }
    },
    "type":"object"
}

Nested Schema : InstancePoolMetadataAction

Type: object

Metadata information to attach or detach instance to the instance pool

Show Source

• instancePoolId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the instance pool where the instance is attached to.
• operationType(required): string
  Allowed Values: [ "ATTACH", "DETACH" ]

  Type to specify whether the requested operation is attaching or detaching instance to the pool

{
    "description":"Metadata information to attach or detach instance to the instance pool",
    "properties":{
        "instancePoolId":{
            "type":"string",
            "description":"The OCID of the instance pool where the instance is attached to.",
            "minLength":"1",
            "maxLength":"255"
        },
        "operationType":{
            "description":"Type to specify whether the requested operation is attaching or detaching instance to the pool",
            "enum":[
                "ATTACH",
                "DETACH"
            ],
            "type":"string"
        }
    },
    "required":[
        "instancePoolId",
        "operationType"
    ],
    "type":"object"
}

Nested Schema : UpdateLaunchOptions

Type: object

Options for tuning the compatibility and performance of VM shapes.

Show Source

• bootVolumeType: string
  Allowed Values: [ "ISCSI", "PARAVIRTUALIZED" ]

  Emulation type for the boot volume. ISCSI - ISCSI attached block storage device. PARAVIRTUALIZED - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images. Before you change the boot volume attachment type, detach all block volumes and VNICs except for the boot volume and the primary VNIC. If the instance is running when you change the boot volume attachment type, it will be rebooted. Note: Some instances might not function properly if you change the boot volume attachment type. After the instance reboots and is running, connect to it. If the connection fails or the OS doesn't behave as expected, the changes are not supported. Revert the instance to the original boot volume attachment type.
• isPvEncryptionInTransitEnabled: boolean
  Whether to enable in-transit encryption for the volume's paravirtualized attachment. To enable in-transit encryption for block volumes and boot volumes, this field must be set to true. Data in transit is transferred over an internal and highly secure network. If you have specific compliance requirements related to the encryption of the data while it is moving between the instance and the boot volume or the block volume, you can enable in-transit encryption. In-transit encryption is not enabled by default. All boot volumes and block volumes are encrypted at rest.
• networkType: string
  Allowed Values: [ "VFIO", "PARAVIRTUALIZED" ]

  Emulation type for the physical network interface card (NIC). 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. Before you change the networking type, detach all VNICs and block volumes except for the primary VNIC and the boot volume. The image must have paravirtualized drivers installed. If the instance is running when you change the network type, it will be rebooted. Note: Some instances might not function properly if you change the networking type. After the instance reboots and is running, connect to it. If the connection fails or the OS doesn't behave as expected, the changes are not supported. Revert the instance to the original networking type.

{
    "description":"Options for tuning the compatibility and performance of VM shapes.",
    "properties":{
        "bootVolumeType":{
            "description":"Emulation type for the boot volume. ISCSI - ISCSI attached block storage device. PARAVIRTUALIZED - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images. Before you change the boot volume attachment type, detach all block volumes and VNICs except for the boot volume and the primary VNIC. If the instance is running when you change the boot volume attachment type, it will be rebooted. Note: Some instances might not function properly if you change the boot volume attachment type. After the instance reboots and is running, connect to it. If the connection fails or the OS doesn't behave as expected, the changes are not supported. Revert the instance to the original boot volume attachment type.",
            "enum":[
                "ISCSI",
                "PARAVIRTUALIZED"
            ],
            "type":"string"
        },
        "networkType":{
            "description":"Emulation type for the physical network interface card (NIC). 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. Before you change the networking type, detach all VNICs and block volumes except for the primary VNIC and the boot volume. The image must have paravirtualized drivers installed. If the instance is running when you change the network type, it will be rebooted. Note: Some instances might not function properly if you change the networking type. After the instance reboots and is running, connect to it. If the connection fails or the OS doesn't behave as expected, the changes are not supported. Revert the instance to the original networking type.",
            "enum":[
                "VFIO",
                "PARAVIRTUALIZED"
            ],
            "type":"string"
        },
        "isPvEncryptionInTransitEnabled":{
            "description":"Whether to enable in-transit encryption for the volume's paravirtualized attachment. To enable in-transit encryption for block volumes and boot volumes, this field must be set to true. Data in transit is transferred over an internal and highly secure network. If you have specific compliance requirements related to the encryption of the data while it is moving between the instance and the boot volume or the block volume, you can enable in-transit encryption. In-transit encryption is not enabled by default. All boot volumes and block volumes are encrypted at rest.",
            "type":"boolean"
        }
    },
    "type":"object"
}

Nested Schema : metadata

Type: object

Additional Properties Allowed

Show Source

• string

{
    "additionalProperties":{
        "type":"string"
    },
    "description":"Custom metadata key/value string pairs that you provide. Any set of key/value pairs provided here will completely replace the current set of key/value pairs in the metadata field on the instance. The \"user_data\" field and the \"ssh_authorized_keys\" field cannot be changed after an instance has launched. Any request that updates, removes, or adds either of these fields will be rejected. You must provide the same values for \"user_data\" and \"ssh_authorized_keys\" that already exist on the instance. The combined size of the metadata and extendedMetadata objects can be a maximum of 32,000 bytes.",
    "type":"object"
}

Custom metadata key/value string pairs that you provide. Any set of key/value pairs provided here will completely replace the current set of key/value pairs in the metadata field on the instance. The "user_data" field and the "ssh_authorized_keys" field cannot be changed after an instance has launched. Any request that updates, removes, or adds either of these fields will be rejected. You must provide the same values for "user_data" and "ssh_authorized_keys" that already exist on the instance. The combined size of the metadata and extendedMetadata objects can be a maximum of 32,000 bytes.

Nested Schema : UpdateInstanceShapeConfigDetails

Type: object

The shape configuration requested for the instance. If provided, the instance will be updated with the resources specified. In the case where some properties are missing, the missing values will be set to the default for the provided shape. Each shape only supports certain configurable values. If the shape is provided and the configuration values are invalid for that new shape, an error will be returned. If no shape is provided and the configuration values are invalid for the instance's existing shape, an error will be returned.

Show Source

• 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 an entire OCPU. This represents a non-burstable instance.
• memoryInGBs: number(float)
  Minimum Value: 0

  The total amount of memory available to the instance, in gigabytes.
• nvmes: integer(int32)
  Minimum Value: 1

  Maximum Value: 4

  The number of NVMe drives to be used for storage. A single drive has 6.8 TB available.
• ocpus: number(float)
  Minimum Value: 0

  The total number of OCPUs available to the instance.

{
    "description":"The shape configuration requested for the instance. If provided, the instance will be updated with the resources specified. In the case where some properties are missing, the missing values will be set to the default for the provided shape. Each shape only supports certain configurable values. If the shape is provided and the configuration values are invalid for that new shape, an error will be returned. If no shape is provided and the configuration values are invalid for the instance's existing shape, an error will be returned.",
    "properties":{
        "ocpus":{
            "description":"The total number of OCPUs available to the instance.",
            "format":"float",
            "minimum":"0",
            "type":"number"
        },
        "memoryInGBs":{
            "description":"The total amount of memory available to the instance, in gigabytes.",
            "format":"float",
            "minimum":"0",
            "type":"number"
        },
        "baselineOcpuUtilization":{
            "description":"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.",
            "enum":[
                "BASELINE_1_8",
                "BASELINE_1_2",
                "BASELINE_1_1"
            ],
            "type":"string"
        },
        "nvmes":{
            "description":"The number of NVMe drives to be used for storage. A single drive has 6.8 TB available.",
            "format":"int32",
            "minimum":"1",
            "maximum":"4",
            "type":"integer"
        }
    },
    "type":"object"
}

Nested Schema : UpdateInstanceSourceDetails

Type: object

Discriminator: sourceType

The details for updating the instance source.

Show Source

• isPreserveBootVolumeEnabled: boolean
  Default Value: true

  Whether to preserve the boot volume that was previously attached to the instance after a successful replacement of that boot volume.
• sourceType(required): string
  The source type for the instance. Use image when specifying the image OCID. Use bootVolume when specifying the boot volume OCID.

{
    "description":"The details for updating the instance source.",
    "discriminator":"sourceType",
    "properties":{
        "sourceType":{
            "description":"The source type for the instance. Use image when specifying the image OCID. Use bootVolume when specifying the boot volume OCID.",
            "type":"string"
        },
        "isPreserveBootVolumeEnabled":{
            "description":"Whether to preserve the boot volume that was previously attached to the instance after a successful replacement of that boot volume.",
            "type":"boolean",
            "default":true
        }
    },
    "required":[
        "sourceType"
    ],
    "type":"object"
}

Nested Schema : pluginsConfig

Type: array

Maximum Length: 128

The configuration of plugins associated with this instance.

Show Source

• Array of: object InstanceAgentPluginConfigDetails
  The configuration of plugins associated with this instance.

{
    "description":"The configuration of plugins associated with this instance.",
    "type":"array",
    "maxLength":"128",
    "items":{
        "$ref":"#/definitions/InstanceAgentPluginConfigDetails"
    }
}

Nested Schema : InstanceAgentPluginConfigDetails

Type: object

The configuration of plugins associated with this instance.

Show Source

• 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.

{
    "description":"The configuration of plugins associated with this instance.",
    "type":"object",
    "properties":{
        "name":{
            "description":"The plugin name. To get a list of available plugins, use the ListInstanceagentAvailablePlugins operation in the Oracle Cloud Agent API.",
            "type":"string",
            "maxLength":"255",
            "minLength":"1"
        },
        "desiredState":{
            "description":"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.",
            "type":"string",
            "enum":[
                "ENABLED",
                "DISABLED"
            ]
        }
    },
    "required":[
        "name",
        "desiredState"
    ]
}

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  The value of the tag. Only the String type is supported.

{
    "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.",
    "type":"object",
    "additionalProperties":{
        "description":"The value of the tag. Only the String type is supported.",
        "type":"object"
    }
}

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

The instance was updated.

Headers

• etag: string
  For optimistic concurrency control. See if-match.
• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
• opc-work-request-id: string
  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

• 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: additionalProperties

  Defined 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: 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).
• 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: 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"}
• 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: additionalProperties

Custom 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: additionalProperties

System 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

{
    "x-obmcs-splat":{
        "resourceKind":"instance",
        "adLocality":"ad-local",
        "activeLifecycleStates":[
            "RUNNING",
            "STOPPED"
        ],
        "deletedLifecycleStates":[
            "TERMINATING",
            "TERMINATED"
        ],
        "getOperationId":"GetInstance",
        "listResourcesOperationId":"ListInstances",
        "ocidEntityType":"instance",
        "generateOcidVersion":"V3",
        "useSurrogateKeyForCreation":true,
        "getBySurrogateKeyUri":"/20160918/instances/surrogateKey",
        "quotaDefinitionUri":"/v1/internal/quotaDefinitions?type=instance",
        "searchMetadata":{
            "resourceSchemaVersion":"1",
            "resourceType":"Instance",
            "scope":"customer",
            "rvnFromHeader":true,
            "showDeletedResources":true
        }
    },
    "description":"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.",
    "properties":{
        "availabilityDomain":{
            "description":"The availability domain the instance is running in. Oracle Private Cloud Appliance has one availability domain: AD-1",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "capacityReservationId":{
            "description":"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.",
            "maxLength":"255",
            "minLength":"0",
            "type":"string",
            "x-default-description":"The default reservation is the reservation into which all instance launches are first attempted. If an instance is launched without specifying a reservation OCID or if a reservation OCID is not present in the JSON input, the instance is automatically launched under this default reservation. To opt out, include capacityReservationId: \"\" in your JSON input. Using an empty string for this field value causes the instance to be launched as a normal instance and not under the default reservation."
        },
        "compartmentId":{
            "description":"The OCID of the compartment that contains the instance.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "dedicatedVmHostId":{
            "description":"The OCID of dedicated VM host.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "definedTags":{
            "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace.",
            "type":"object",
            "additionalProperties":{
                "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.",
                "type":"object",
                "additionalProperties":{
                    "description":"The value of the tag. Only the String type is supported.",
                    "type":"object"
                }
            }
        },
        "displayName":{
            "description":"A user-friendly name. Does not need to be unique, and it is changeable. Avoid entering confidential information.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "extendedMetadata":{
            "additionalProperties":{
                "type":"object"
            },
            "description":"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).",
            "type":"object"
        },
        "faultDomain":{
            "description":"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 ",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "freeformTags":{
            "description":"Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {\"Department\": \"Finance\"} ",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "id":{
            "description":"The OCID of the instance.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "imageId":{
            "description":"Deprecated. Use sourceDetails instead.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "ipxeScript":{
            "description":"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.<p>Note: The same iPXE script will run every time an instance boots, not only after the initial LaunchInstance call.<p>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.",
            "maxLength":"10240",
            "minLength":"1",
            "type":"string"
        },
        "launchMode":{
            "description":"Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are:<li>NATIVE - VM instances launch with iSCSI boot and VFIO devices. The default value for platform images.<li>EMULATED - VM instances launch with emulated devices, such as the E1000 network driver and emulated SCSI disk controller.<li>PARAVIRTUALIZED - VM instances launch with paravirtualized devices using VirtIO drivers.<li>CUSTOM - VM instances launch with custom configuration settings specified in the LaunchOptions parameter.",
            "enum":[
                "NATIVE",
                "EMULATED",
                "PARAVIRTUALIZED",
                "CUSTOM"
            ],
            "type":"string",
            "x-obmcs-resolve-component-ref":true
        },
        "launchOptions":{
            "$ref":"#/definitions/LaunchOptions"
        },
        "instanceOptions":{
            "$ref":"#/definitions/InstanceOptions"
        },
        "availabilityConfig":{
            "$ref":"#/definitions/InstanceAvailabilityConfig"
        },
        "preemptibleInstanceConfig":{
            "$ref":"#/definitions/PreemptibleInstanceConfigDetails"
        },
        "lifecycleState":{
            "description":"The current state of the instance.",
            "enum":[
                "MOVING",
                "PROVISIONING",
                "RUNNING",
                "STARTING",
                "STOPPING",
                "STOPPED",
                "SUSPENDING",
                "SUSPENDED",
                "CREATING_IMAGE",
                "TERMINATING",
                "TERMINATED"
            ],
            "type":"string"
        },
        "metadata":{
            "additionalProperties":{
                "type":"string"
            },
            "description":"Custom metadata that you provide.",
            "type":"object"
        },
        "region":{
            "description":"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.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "shape":{
            "description":"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.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "shapeConfig":{
            "$ref":"#/definitions/InstanceShapeConfig"
        },
        "sourceDetails":{
            "$ref":"#/definitions/InstanceSourceDetails"
        },
        "systemTags":{
            "description":"System tags for this resource. Each key is predefined and scoped to a namespace.",
            "type":"object",
            "additionalProperties":{
                "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.",
                "type":"object",
                "additionalProperties":{
                    "description":"The value of the tag. Only the String type is supported.",
                    "type":"object"
                }
            }
        },
        "timeCreated":{
            "description":"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 ",
            "format":"date-time",
            "type":"string"
        },
        "agentConfig":{
            "$ref":"#/definitions/InstanceAgentConfig"
        },
        "timeMaintenanceRebootDue":{
            "description":"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 ",
            "format":"date-time",
            "type":"string"
        },
        "timeStopScheduled":{
            "description":"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 ",
            "format":"date-time",
            "type":"string"
        },
        "preferredMaintenanceAction":{
            "description":"The preferred maintenance action for an instance. LIVE_MIGRATE - Run maintenance using a live migration. REBOOT - Run maintenance using a reboot.",
            "enum":[
                "LIVE_MIGRATE",
                "REBOOT"
            ],
            "type":"string"
        },
        "platformConfig":{
            "$ref":"#/definitions/PlatformConfig"
        }
    },
    "required":[
        "id",
        "compartmentId",
        "shape",
        "region",
        "availabilityDomain",
        "lifecycleState",
        "timeCreated"
    ],
    "type":"object"
}

Nested Schema : InstanceAgentConfig

Type: object

Configuration options for the Oracle Cloud Agent software running on the instance.

Show Source

• 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.

{
    "description":"Configuration options for the Oracle Cloud Agent software running on the instance.",
    "properties":{
        "isMonitoringDisabled":{
            "description":"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.",
            "type":"boolean",
            "default":false
        },
        "isManagementDisabled":{
            "description":"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.",
            "type":"boolean",
            "default":false
        },
        "areAllPluginsDisabled":{
            "description":"Whether Oracle Cloud Agent can run all of the available plugins. This includes the management and monitoring plugins.",
            "type":"boolean",
            "default":false
        },
        "pluginsConfig":{
            "description":"The configuration of plugins associated with this instance.",
            "type":"array",
            "maxLength":"128",
            "items":{
                "$ref":"#/definitions/InstanceAgentPluginConfigDetails"
            }
        }
    },
    "type":"object"
}

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

• 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.

{
    "description":"Options for defining the availabiity of a VM instance after a maintenance event that impacts the underlying hardware.",
    "properties":{
        "isLiveMigrationPreferred":{
            "description":"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.",
            "type":"boolean"
        },
        "recoveryAction":{
            "default":"RESTORE_INSTANCE",
            "description":"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.",
            "enum":[
                "RESTORE_INSTANCE",
                "STOP_INSTANCE"
            ],
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : definedTags

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

  Key-value pair representing a defined tag key and value, scoped to a namespace.

{
    "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace.",
    "type":"object",
    "additionalProperties":{
        "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.",
        "type":"object",
        "additionalProperties":{
            "description":"The value of the tag. Only the String type is supported.",
            "type":"object"
        }
    }
}

Defined tags for this resource. Each key is predefined and scoped to a namespace.

Nested Schema : extendedMetadata

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "additionalProperties":{
        "type":"object"
    },
    "description":"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).",
    "type":"object"
}

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

• string

{
    "description":"Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {\"Department\": \"Finance\"} ",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

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

• 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.

{
    "description":"Optional mutable instance options",
    "properties":{
        "areLegacyImdsEndpointsDisabled":{
            "description":"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.",
            "type":"boolean"
        }
    },
    "type":"object"
}

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.
• 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.

{
    "description":"Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.",
    "properties":{
        "bootVolumeType":{
            "description":"Emulation type for the boot volume. See the description of LaunchInstance for descriptions of each possible value.",
            "enum":[
                "ISCSI",
                "SCSI",
                "IDE",
                "VFIO",
                "PARAVIRTUALIZED",
                "NVME"
            ],
            "type":"string"
        },
        "firmware":{
            "description":"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.",
            "enum":[
                "BIOS",
                "UEFI_64"
            ],
            "type":"string"
        },
        "networkType":{
            "description":"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.",
            "enum":[
                "E1000",
                "VFIO",
                "PARAVIRTUALIZED"
            ],
            "type":"string"
        },
        "remoteDataVolumeType":{
            "description":"Emulation type for volume.<li>ISCSI - ISCSI attached block storage device.<li>SCSI - Emulated SCSI disk.<li>IDE - Emulated IDE disk.<li>VFIO - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images.<li>PARAVIRTUALIZED - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images.<li>NVME - NVMe disk.",
            "enum":[
                "ISCSI",
                "SCSI",
                "IDE",
                "VFIO",
                "PARAVIRTUALIZED",
                "NVME"
            ],
            "type":"string"
        },
        "isPvEncryptionInTransitEnabled":{
            "description":"Deprecated. Instead use isPvEncryptionInTransitEnabled in LaunchInstanceDetails.",
            "type":"boolean"
        },
        "isConsistentVolumeNamingEnabled":{
            "description":"Whether to enable consistent volume naming feature. Defaults to false.",
            "type":"boolean"
        }
    },
    "type":"object"
}

Nested Schema : metadata

Type: object

Additional Properties Allowed

Show Source

• string

{
    "additionalProperties":{
        "type":"string"
    },
    "description":"Custom metadata that you provide.",
    "type":"object"
}

Custom metadata that you provide.

Nested Schema : PlatformConfig

Type: object

Discriminator: type

The platform configuration for the instance.

Show Source

• 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.

{
    "description":"The platform configuration for the instance.",
    "discriminator":"type",
    "properties":{
        "type":{
            "description":"The type of platform being configured.",
            "type":"string",
            "enum":[
                "AMD_MILAN_BM",
                "AMD_MILAN_BM_GPU",
                "AMD_ROME_BM",
                "AMD_ROME_BM_GPU",
                "INTEL_ICELAKE_BM",
                "INTEL_SKYLAKE_BM",
                "AMD_VM",
                "INTEL_VM"
            ]
        },
        "isSecureBootEnabled":{
            "description":"Whether Secure Boot is enabled on the instance.",
            "type":"boolean",
            "default":false
        },
        "isTrustedPlatformModuleEnabled":{
            "description":"Whether the Trusted Platform Module (TPM) is enabled on the instance.",
            "type":"boolean",
            "default":false
        },
        "isMeasuredBootEnabled":{
            "description":"Whether the Measured Boot feature is enabled on the instance.",
            "type":"boolean",
            "default":false
        },
        "isMemoryEncryptionEnabled":{
            "description":"Whether the instance is a confidential instance. If this value is true, the instance is a confidential instance. The default value is false.",
            "type":"boolean",
            "default":false
        }
    },
    "required":[
        "type"
    ],
    "type":"object"
}

Nested Schema : PreemptibleInstanceConfigDetails

Type: object

Configuration options for preemptible instances.

Show Source

• preemptionAction(required): object PreemptionAction
  Discriminator: type

  The action to run when the preemptible node is interrupted for eviction.

{
    "description":"Configuration options for preemptible instances.",
    "type":"object",
    "properties":{
        "preemptionAction":{
            "$ref":"#/definitions/PreemptionAction"
        }
    },
    "required":[
        "preemptionAction"
    ]
}

Nested Schema : InstanceShapeConfig

Type: object

The shape configuration for an instance. The shape configuration determines the resources allocated to an instance.

Show Source

• 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).

{
    "description":"The shape configuration for an instance. The shape configuration determines the resources allocated to an instance.",
    "properties":{
        "ocpus":{
            "description":"The total number of OCPUs available to the instance.",
            "format":"float",
            "minimum":"0",
            "type":"number"
        },
        "memoryInGBs":{
            "description":"The total amount of memory available to the instance, in gigabytes.",
            "format":"float",
            "minimum":"0",
            "type":"number"
        },
        "baselineOcpuUtilization":{
            "description":"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.",
            "enum":[
                "BASELINE_1_8",
                "BASELINE_1_2",
                "BASELINE_1_1"
            ],
            "type":"string"
        },
        "processorDescription":{
            "description":"A short description of the instance's processor (CPU).",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "networkingBandwidthInGbps":{
            "description":"The networking bandwidth available to the instance, in gigabits per second.",
            "format":"float",
            "minimum":"0",
            "type":"number"
        },
        "maxVnicAttachments":{
            "description":"The maximum number of VNIC attachments for the instance.",
            "minimum":"0",
            "type":"integer"
        },
        "gpus":{
            "description":"The number of GPUs available to the instance.",
            "minimum":"0",
            "type":"integer"
        },
        "gpuDescription":{
            "description":"A short description of the instance's graphics processing unit (GPU). If the instance does not have any GPUs, this field is null.",
            "type":"string"
        },
        "localDisks":{
            "description":"The number of local disks available to the instance.",
            "minimum":"0",
            "type":"integer"
        },
        "localDisksTotalSizeInGBs":{
            "description":"The aggregate size of all local disks, in gigabytes. If the instance does not have any local disks, this field is null.",
            "format":"float",
            "minimum":"0",
            "type":"number"
        },
        "localDiskDescription":{
            "description":"A short description of the local disks available to this instance. If the instance does not have any local disks, this field is null.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : InstanceSourceDetails

Type: object

Discriminator: sourceType

Show Source

• sourceType(required): string
  The source type for the instance. Use image when specifying the image OCID. Use bootVolume when specifying the boot volume OCID.

{
    "discriminator":"sourceType",
    "properties":{
        "sourceType":{
            "description":"The source type for the instance. Use image when specifying the image OCID. Use bootVolume when specifying the boot volume OCID.",
            "type":"string"
        }
    },
    "required":[
        "sourceType"
    ],
    "type":"object"
}

Nested Schema : systemTags

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

  Key-value pair representing a defined tag key and value, scoped to a namespace.

{
    "description":"System tags for this resource. Each key is predefined and scoped to a namespace.",
    "type":"object",
    "additionalProperties":{
        "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.",
        "type":"object",
        "additionalProperties":{
            "description":"The value of the tag. Only the String type is supported.",
            "type":"object"
        }
    }
}

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

• Array of: object InstanceAgentPluginConfigDetails
  The configuration of plugins associated with this instance.

{
    "description":"The configuration of plugins associated with this instance.",
    "type":"array",
    "maxLength":"128",
    "items":{
        "$ref":"#/definitions/InstanceAgentPluginConfigDetails"
    }
}

Nested Schema : InstanceAgentPluginConfigDetails

Type: object

The configuration of plugins associated with this instance.

Show Source

• 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.

{
    "description":"The configuration of plugins associated with this instance.",
    "type":"object",
    "properties":{
        "name":{
            "description":"The plugin name. To get a list of available plugins, use the ListInstanceagentAvailablePlugins operation in the Oracle Cloud Agent API.",
            "type":"string",
            "maxLength":"255",
            "minLength":"1"
        },
        "desiredState":{
            "description":"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.",
            "type":"string",
            "enum":[
                "ENABLED",
                "DISABLED"
            ]
        }
    },
    "required":[
        "name",
        "desiredState"
    ]
}

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  The value of the tag. Only the String type is supported.

{
    "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.",
    "type":"object",
    "additionalProperties":{
        "description":"The value of the tag. Only the String type is supported.",
        "type":"object"
    }
}

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

• type(required): string
  Allowed Values: [ "TERMINATE" ]

  The type of action to run when the instance is interrupted for eviction.

{
    "required":[
        "type"
    ],
    "description":"The action to run when the preemptible node is interrupted for eviction.",
    "discriminator":"type",
    "properties":{
        "type":{
            "description":"The type of action to run when the instance is interrupted for eviction.",
            "type":"string",
            "enum":[
                "TERMINATE"
            ]
        }
    },
    "type":"object"
}

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  The value of the tag. Only the String type is supported.

{
    "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.",
    "type":"object",
    "additionalProperties":{
        "description":"The value of the tag. Only the String type is supported.",
        "type":"object"
    }
}

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.

401 Response

Unauthorized

Headers

• opc-request-id: string
  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

• 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

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

404 Response

Not Found

Headers

• opc-request-id: string
  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

• 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

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

409 Response

Conflict

Headers

• opc-request-id: string
  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

• 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

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

412 Response

Precondition Failed

Headers

• opc-request-id: string
  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

• 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

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

500 Response

Internal Server Error

Headers

• opc-request-id: string
  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

• 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

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

Default Response

An error has occurred.

Headers

• opc-request-id: string
  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

• 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

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

Back to Top