ListBootVolumeAttachments
get
/20160918/bootVolumeAttachments
List the boot volume attachments in the specified compartment. You can filter the list by specifying an instance OCID, boot volume OCID, or both.
Request
Supported Media Types
- application/json
Query Parameters
-
availabilityDomain(required): string
The name of the availability domain. Example: AD-1
-
bootVolumeId: string
The OCID of the boot volume.
-
compartmentId(required): string
Minimum Length:
1
Maximum Length:255
The OCID of the compartment. -
instanceId: string
The OCID of the instance.
-
limit: integer
Minimum Value:
1
Maximum Value:1000
For list pagination. The maximum number of results per page, or items to return in a paginated List call. 1 is the minimum, 1000 is the maximum.Default Value:100
-
page: string
Minimum Length:
1
Maximum Length:512
For list pagination. The value of the opc-next-page response header from the previous List call.Default Value:oracle.doceng.json.BetterJsonNull@2c07545f
Response
Supported Media Types
- application/json
- application/x-json-stream
200 Response
The list is being retrieved.
Headers
-
opc-next-page: string
For list pagination. When this header appears in the response, additional pages of results remain. Use this value as the page parameter to get the next page of items.
-
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 : schema
Type:
Show Source
array
-
Array of:
object BootVolumeAttachment
Represents an attachment between a boot volume and an instance. Avoid entering confidential information.
Nested 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
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