AttachBootVolume
post
/20160918/bootVolumeAttachments
Attach the specified boot volume to the specified instance.
Request
Supported Media Types
- application/json
Header Parameters
-
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).
Attach boot volume request
Root Schema : AttachBootVolumeDetails
Type:
Show Source
object
-
bootVolumeId(required):
string
Minimum Length:
1
Maximum Length:255
The OCID of the boot volume. -
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. -
encryptionInTransitType:
string
Default Value:
NONE
Allowed Values:[ "NONE", "BM_ENCRYPTION_IN_TRANSIT" ]
Refer the top-level definition of encryptionInTransitType. The default value is NONE. -
instanceId(required):
string
Minimum Length:
1
Maximum Length:255
The OCID of the instance.
Response
Supported Media Types
- application/json
200 Response
The boot volume is being attached.
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.
Root Schema : BootVolumeAttachment
Type:
object
Represents an attachment between a boot volume and an instance. Avoid entering confidential information.
Show Source
-
attachmentType:
string
Minimum Length:
1
Maximum Length:255
The type of boot volume attachment. -
availabilityDomain(required):
string
Minimum Length:
1
Maximum Length:255
The availability domain of an instance. For Oracle Private Cloud Appliance, the availability domain is AD-1. -
bootVolumeId(required):
string
Minimum Length:
1
Maximum Length:255
The OCID of the boot volume. -
compartmentId(required):
string
Minimum Length:
1
Maximum Length:255
The OCID of the compartment. -
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. -
encryptionInTransitType:
string
Default Value:
NONE
Allowed Values:[ "NONE", "BM_ENCRYPTION_IN_TRANSIT" ]
Refer the top-level definition of encryptionInTransitType. The default value is NONE. -
id(required):
string
Minimum Length:
1
Maximum Length:255
The OCID of the boot volume attachment. -
instanceId(required):
string
Minimum Length:
1
Maximum Length:255
The OCID of the instance the boot volume is attached to. -
isEncryptionInTransitEnabled:
boolean
Whether in-transit encryption for the boot volume's attachment is enabled or not.
-
isPvEncryptionInTransitEnabled:
boolean
Deprecated. Use isEncryptionInTransitEnabled instead.
-
lifecycleState(required):
string
Allowed Values:
[ "ATTACHING", "ATTACHED", "DETACHING", "DETACHED" ]
The current state of the boot volume attachment. -
timeCreated(required):
string(date-time)
The date and time the boot volume was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z
400 Response
Bad Request
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.
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
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.
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
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.
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
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.
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
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.
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
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.
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