GetVolumeAttachment
get
/20160918/volumeAttachments/{volume_attachment_id}
Get information about the specified volume attachment.
Request
Supported Media Types
- application/json
Path Parameters
-
volumeAttachmentId(required): string
The OCID of the volume attachment.
Response
Supported Media Types
- application/json
200 Response
The volume attachment was retrieved.
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 : VolumeAttachment
Type:
object
Discriminator:
attachmentType
A base object for all types of attachments between a storage volume and an instance. For specific details about iSCSI attachments, see IScsiVolumeAttachment. Avoid using confidential information when you supply string values using the API.
Show Source
-
attachmentType(required):
string
Minimum Length:
1
Maximum Length:255
The type of volume attachment. -
availabilityDomain(required):
string
Minimum Length:
1
Maximum Length:255
The availability domain of an instance. Example: AD-1 -
compartmentId(required):
string
Minimum Length:
1
Maximum Length:255
The OCID of the compartment. -
device:
string
Minimum Length:
3
Maximum Length:100
The device name. -
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. -
id(required):
string
Minimum Length:
1
Maximum Length:255
The OCID of the volume attachment. -
instanceId(required):
string
Minimum Length:
1
Maximum Length:255
The OCID of the instance the volume is attached to. -
iscsiLoginState:
string
Allowed Values:
[ "UNKNOWN", "LOGGING_IN", "LOGIN_SUCCEEDED", "LOGIN_FAILED", "LOGGING_OUT", "LOGOUT_SUCCEEDED", "LOGOUT_FAILED" ]
The iscsi login state of the volume attachment. For a Iscsi volume attachment, all iscsi sessions need to be all logged-in or logged-out to be in logged-in or logged-out state. -
isEncryptionInTransitEnabled:
boolean
Whether in-transit encryption for the data volume's attachment is enabled or not.
-
isMultipath:
boolean
Whether the Iscsi or Paravirtualized attachment is multipath or not, it is not applicable to NVMe attachment.
-
isPvEncryptionInTransitEnabled:
boolean
Deprecated. Use isEncryptionInTransitEnabled instead.
-
isReadOnly:
boolean
Whether the attachment was created in read-only mode.
- isShareable: boolean
-
lifecycleState(required):
string
Allowed Values:
[ "ATTACHING", "ATTACHED", "DETACHING", "DETACHED" ]
The current state of the volume attachment. -
timeCreated(required):
string(date-time)
The date and time the volume was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z
-
volumeId(required):
string
Minimum Length:
1
Maximum Length:255
The OCID of the volume.
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