Create a Boot Volume

post

/20160918/bootVolumes

Create a new boot volume in the specified compartment from an existing boot volume or a boot volume backup. You may optionally specify a display name for the volume. The display name does not need to be unique, and you can change it. Avoid entering confidential information.

Request

Supported Media Types
Header Parameters
  • Minimum Length: 1
    Maximum Length: 64
    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
Body ()
Request to create a new boot volume.
Root Schema : CreateBootVolumeDetails
Type: object
Show Source
  • autotunePolicies
    Unique Items Required: true
    The list of autotune policies to be enabled for this volume.
  • Minimum Length: 1
    Maximum Length: 255
    The availability domain of the volume. Omissible for cloning a volume. The new volume will be created in the availability domain of the source volume. Example: AD-1
  • Minimum Length: 1
    Maximum Length: 255
    Specifies the OCID of the boot volume backup policy to assign to the newly created boot volume. If omitted, no policy will be assigned.
  • bootVolumeReplicas
    Maximum Number of Items: 1
    Unique Items Required: true
    The list of boot volume replicas to be enabled for this boot volume in the specified destination availability domains.
  • Minimum Length: 1
    Maximum Length: 255
    The buildingHint for volume creation. This is an internal parameter passed by compute for best effort collocation.
  • Minimum Length: 1
    Maximum Length: 255
    The clusterPlacementGroup ID of the volume for volume placement.
  • Minimum Length: 1
    Maximum Length: 255
    The OCID of the compartment that contains the boot volume.
  • definedTags
    Additional Properties Allowed: additionalProperties
    Defined tags for this resource. Each key is predefined and scoped to a namespace.
  • Minimum Length: 1
    Maximum Length: 255
    A user-friendly name. Does not need to be unique, and it is changeable. Avoid entering confidential information.
  • freeformTags
    Additional Properties Allowed: additionalProperties
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}
  • Specifies whether the auto-tune performance is enabled for this boot volume. This field is deprecated. Use the DetachedVolumeAutotunePolicy instead to enable the volume for detached autotune.
  • Minimum Length: 1
    Maximum Length: 255
    The OCID of the Key Management key to assign as the master encryption key for the boot volume.
  • Minimum Length: 1
    Maximum Length: 255
    The siteGroup ID of the volume. This is an internal parameter. If clusterPlacementGroup is specified by external customer this field will be ignored.
  • The size of the volume in GBs.
  • BootVolumeSourceDetails
    Discriminator: type
  • The flag indicating the given source volumes will be used for producing a thin clone or full clone.
  • The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. Allowed values are: 10 - Balanced option. 20 - Higher Performance option.
  • Minimum Length: 1
    Maximum Length: 255
    The OCID of the Vault service key, which is the master encryption key for the boot volume cross region backups, which will be used in the destination region to encrypt the backup's encryption keys.
Nested Schema : autotunePolicies
Type: array
Unique Items Required: true
The list of autotune policies to be enabled for this volume.
Show Source
Nested Schema : bootVolumeReplicas
Type: array
Maximum Number of Items: 1
Unique Items Required: true
The list of boot volume replicas to be enabled for this boot volume in the specified destination availability domains.
Show Source
Nested Schema : definedTags
Type: object
Additional Properties Allowed
Show Source
Defined tags for this resource. Each key is predefined and scoped to a namespace.
Nested Schema : freeformTags
Type: object
Additional Properties Allowed
Show Source
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 : BootVolumeSourceDetails
Type: object
Discriminator: type
Show Source
Nested Schema : AutotunePolicy
Type: object
Discriminator: autotuneType
An autotune policy automatically tunes the volume's performace based on the type of the policy.
Show Source
Nested Schema : BootVolumeReplicaDetails
Type: object
Contains the details for the boot volume replica
Show Source
  • Minimum Length: 1
    Maximum Length: 255
    The availability domain of the boot volume replica. Example: AD-1
  • Minimum Length: 1
    Maximum Length: 255
    A user-friendly name. Does not need to be unique, and it is changeable. Avoid entering confidential information.
  • Minimum Length: 1
    Maximum Length: 255
    The OCID of the Vault service key which is the master encryption key for the cross region boot volume replicas, which will be used in the destination region to encrypt the boot volume replica's encryption keys.
Nested Schema : additionalProperties
Type: object
Additional Properties Allowed
Show Source
Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}`
Nested Schema : additionalProperties
Type: object
The value of the tag. Only the String type is supported.
Back to Top

Response

Supported Media Types

200 Response

The boot volume is being created.
Headers
  • For optimistic concurrency control. See `if-match`.
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : BootVolume
Type: object
A detachable boot volume device that contains the image used to boot a Compute instance. For more information, see [Managing Boot Volumes](https://docs.oracle.com/en/engineered-systems/private-cloud-appliance/3.0-latest/user/user-usr-blk-bootvolumes.html). Avoid entering confidential information when you supply string values using the API.
Show Source
Nested Schema : autotunePolicies
Type: array
Unique Items Required: true
The list of autotune policies enabled for this volume.
Show Source
Nested Schema : bootVolumeReplicas
Type: array
The list of boot volume replicas of this boot volume
Show Source
Nested Schema : definedTags
Type: object
Additional Properties Allowed
Show Source
Defined tags for this resource. Each key is predefined and scoped to a namespace.
Nested Schema : freeformTags
Type: object
Additional Properties Allowed
Show Source
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}
Nested Schema : BootVolumeSourceDetails
Type: object
Discriminator: type
Show Source
Nested Schema : systemTags
Type: object
Additional Properties Allowed
Show Source
System tags for this resource. Each key is predefined and scoped to a namespace.
Nested Schema : AutotunePolicy
Type: object
Discriminator: autotuneType
An autotune policy automatically tunes the volume's performace based on the type of the policy.
Show Source
Nested Schema : BootVolumeReplicaInfo
Type: object
Information about the boot volume replica in the destination availability domain.
Show Source
Nested Schema : additionalProperties
Type: object
Additional Properties Allowed
Show Source
Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}`
Nested Schema : additionalProperties
Type: object
The value of the tag. Only the String type is supported.
Nested Schema : additionalProperties
Type: object
Additional Properties Allowed
Show Source
Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}`
Nested Schema : additionalProperties
Type: object
The value of the tag. Only the String type is supported.

400 Response

Bad Request
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
The properties that define an error.
Show Source
  • A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
  • A human-readable error string.

401 Response

Unauthorized
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
The properties that define an error.
Show Source
  • A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
  • A human-readable error string.

404 Response

Not Found
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
The properties that define an error.
Show Source
  • A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
  • A human-readable error string.

409 Response

Conflict
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
The properties that define an error.
Show Source
  • A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
  • A human-readable error string.

500 Response

Internal Server Error
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
The properties that define an error.
Show Source
  • A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
  • A human-readable error string.

Default Response

An error has occurred.
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
The properties that define an error.
Show Source
  • A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
  • A human-readable error string.
Back to Top