Update a Boot Volume
put
/20160918/bootVolumes/{boot_volume_id}
Update the specified boot volume's display name, defined tags, and free-form tags.
Request
Supported Media Types
- application/json
Path Parameters
-
bootVolumeId(required): string
The OCID of the boot volume.
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.
Update boot volume's display name.
Root Schema : UpdateBootVolumeDetails
Type:
Show Source
object
-
autotunePolicies:
array autotunePolicies
Unique Items Required:
true
The list of autotune policies to be enabled for this volume. -
bootVolumeReplicas:
array bootVolumeReplicas
Maximum Number of Items:
1
Unique Items Required:true
The list of boot volume replicas that this boot volume will be updated to have in the specified destination availability domains. -
definedTags:
object definedTags
Additional Properties Allowed: additionalPropertiesDefined tags for this resource. Each key is predefined and scoped to a namespace.
-
displayName:
string
Minimum Length:
1
Maximum Length:255
A user-friendly name. Does not need to be unique, and it is changeable. Avoid entering confidential information. -
freeformTags:
object freeformTags
Additional Properties Allowed: additionalPropertiesFree-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}
-
isAutoTuneEnabled:
boolean
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.
-
sizeInGBs:
integer(int64)
The size to resize the volume to in GBs. Has to be larger than the current size.
-
volumeType:
string
The flag indicating given volume is a thin clone or full clone.
-
vpusPerGB:
integer(int64)
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.
Nested Schema : autotunePolicies
Type:
array
Unique Items Required:
true
The list of autotune policies to be enabled for this volume.
Show Source
-
Array of:
object AutotunePolicy
Discriminator:
autotuneType
An autotune policy automatically tunes the volume's performace based on the type of the policy.
Nested Schema : bootVolumeReplicas
Type:
array
Maximum Number of Items:
1
Unique Items Required:
true
The list of boot volume replicas that this boot volume will be updated to have in the specified destination availability domains.
Show Source
-
Array of:
object BootVolumeReplicaDetails
Contains the details for the boot volume replica
Nested Schema : definedTags
Type:
object
Additional Properties Allowed
Show Source
-
object additionalProperties
Additional Properties Allowed: additionalPropertiesKey-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}`
Defined tags for this resource. Each key is predefined and scoped to a namespace.
Nested Schema : freeformTags
Type:
object
Additional Properties Allowed
Show Source
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}
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
-
autotuneType(required):
string
Allowed Values:
[ "DETACHED_VOLUME", "PERFORMANCE_BASED" ]
This specifies the type of autotunes supported by OCI.
Nested Schema : BootVolumeReplicaDetails
Type:
object
Contains the details for the boot volume replica
Show Source
-
availabilityDomain(required):
string
Minimum Length:
1
Maximum Length:255
The availability domain of the boot volume replica. Example: AD-1 -
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. -
xrrKmsKeyId:
string
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
-
object additionalProperties
The value of the tag. Only the String type is supported.
Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}`
Nested Schema : additionalProperties
Type:
object
The value of the tag. Only the String type is supported.
Response
Supported Media Types
- application/json
200 Response
The boot volume was updated.
Headers
-
etag: string
For optimistic concurrency control. See `if-match`.
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Root Schema : 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
-
autoTunedVpusPerGB:
integer(int64)
The number of Volume Performance Units per GB that this boot volume is effectively tuned to.
-
autotunePolicies:
array autotunePolicies
Unique Items Required:
true
The list of autotune policies enabled for this volume. -
availabilityDomain(required):
string
Minimum Length:
1
Maximum Length:255
The availability domain of the boot volume. Example: AD-1 -
bootVolumeReplicas:
array bootVolumeReplicas
The list of boot volume replicas of this boot volume
-
clusterPlacementGroupId:
string
Minimum Length:
1
Maximum Length:255
The clusterPlacementGroup ID of the volume for volume placement. -
compartmentId(required):
string
Minimum Length:
1
Maximum Length:255
The OCID of the compartment that contains the boot volume. -
definedTags:
object definedTags
Additional Properties Allowed: additionalPropertiesDefined tags for this resource. Each key is predefined and scoped to a namespace.
-
displayName:
string
Minimum Length:
1
Maximum Length:255
A user-friendly name. Does not need to be unique, and it is changeable. Avoid entering confidential information. -
freeformTags:
object freeformTags
Additional Properties Allowed: additionalPropertiesFree-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}
-
id(required):
string
Minimum Length:
1
Maximum Length:255
The boot volume's OCID. -
imageId:
string
Minimum Length:
1
Maximum Length:255
The image OCID used to create the boot volume. -
isAutoTuneEnabled:
boolean
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.
-
isHydrated:
boolean
Specifies whether the boot volume's data has finished copying from the source boot volume or boot volume backup.
-
kmsKeyId:
string
Minimum Length:
1
Maximum Length:255
The OCID of the Vault service master encryption key assigned to the boot volume. -
lifecycleState(required):
string
Allowed Values:
[ "PROVISIONING", "RESTORING", "AVAILABLE", "TERMINATING", "TERMINATED", "FAULTY" ]
The current state of a boot volume. -
sizeInGBs:
integer(int64)
The size of the boot volume in GBs.
-
sizeInMBs(required):
integer(int64)
The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use sizeInGBs.
-
sourceDetails:
object BootVolumeSourceDetails
Discriminator:
type
-
systemTags:
object systemTags
Additional Properties Allowed: additionalPropertiesSystem tags for this resource. Each key is predefined and scoped to a namespace.
-
timeCreated(required):
string(date-time)
The date and time the boot volume was created. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
-
volumeGroupId:
string
Minimum Length:
1
Maximum Length:255
The OCID of the source volume group. -
volumeType:
string
Allowed Values:
[ "FULL", "THIN_CLONE" ]
An optional field to create/promote thin clones. When it is null, regular volumes are created. A thin clone promotion to full clone (an independent volume) occurs when FULL is used in update API A thin clone is created by specifying THIN_CLONE in create request. -
vpusPerGB:
integer(int64)
The number of volume performance units (VPUs) that will be applied to this boot volume per GB, representing the Block Volume service's elastic performance options. Allowed values are: 10 - Balanced option. 20 - Higher Performance option.
Nested Schema : autotunePolicies
Type:
array
Unique Items Required:
true
The list of autotune policies enabled for this volume.
Show Source
-
Array of:
object AutotunePolicy
Discriminator:
autotuneType
An autotune policy automatically tunes the volume's performace based on the type of the policy.
Nested Schema : bootVolumeReplicas
Type:
array
The list of boot volume replicas of this boot volume
Show Source
-
Array of:
object BootVolumeReplicaInfo
Information about the boot volume replica in the destination availability domain.
Nested Schema : definedTags
Type:
object
Additional Properties Allowed
Show Source
-
object additionalProperties
Additional Properties Allowed: additionalPropertiesKey-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}`
Defined tags for this resource. Each key is predefined and scoped to a namespace.
Nested Schema : freeformTags
Type:
object
Additional Properties Allowed
Show Source
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}
Nested Schema : systemTags
Type:
object
Additional Properties Allowed
Show Source
-
object additionalProperties
Additional Properties Allowed: additionalPropertiesKey-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}`
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
-
autotuneType(required):
string
Allowed Values:
[ "DETACHED_VOLUME", "PERFORMANCE_BASED" ]
This specifies the type of autotunes supported by OCI.
Nested Schema : BootVolumeReplicaInfo
Type:
object
Information about the boot volume replica in the destination availability domain.
Show Source
-
availabilityDomain(required):
string
Minimum Length:
1
Maximum Length:255
The availability domain of the boot volume replica. Example: AD-1 -
bootVolumeReplicaId(required):
string
Minimum Length:
1
Maximum Length:255
The boot volume replica's OCID. -
displayName(required):
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. -
kmsKeyId:
string
Minimum Length:
1
Maximum Length:255
The OCID of the Vault service key to assign as the master encryption key for the block volume replica.
Nested Schema : additionalProperties
Type:
object
Additional Properties Allowed
Show Source
-
object additionalProperties
The value of the tag. Only the String type is supported.
Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}`
Nested Schema : additionalProperties
Type:
object
The value of the tag. Only the String type is supported.
Nested Schema : additionalProperties
Type:
object
Additional Properties Allowed
Show Source
-
object additionalProperties
The value of the tag. Only the String type is supported.
Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}`
Nested Schema : additionalProperties
Type:
object
The value of the tag. Only the String type is supported.
400 Response
Bad Request
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
-
message(required):
string
A human-readable error string.
401 Response
Unauthorized
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
-
message(required):
string
A human-readable error string.
404 Response
Not Found
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
-
message(required):
string
A human-readable error string.
412 Response
Precondition Failed
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
-
message(required):
string
A human-readable error string.
500 Response
Internal Server Error
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
-
message(required):
string
A human-readable error string.
Default Response
An error has occurred.
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
-
message(required):
string
A human-readable error string.