Jump to

• Request
• Response

Get a Volume Attachment

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.

Back to Top

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. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

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
  Whether the attachment should be created in shareable mode. If an attachment is created in shareable mode, then other instances can attach the same volume, provided that they also create their attachments in shareable mode. Only certain volume types can be attached in shareable mode. Defaults to false if not specified.
• isVolumeCreatedDuringLaunch: boolean
  Flag indicating if this volume was created for the customer as part of a simplified launch. Used to determine whether the volume requires deletion on instance termination.
• 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.

{
    "x-obmcs-splat":{
        "resourceKind":"VolumeAttachment",
        "adLocality":"ad-local"
    },
    "description":"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.",
    "discriminator":"attachmentType",
    "properties":{
        "attachmentType":{
            "description":"The type of volume attachment.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "availabilityDomain":{
            "description":"The availability domain of an instance. Example: AD-1 ",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "compartmentId":{
            "description":"The OCID of the compartment.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "device":{
            "description":"The device name.",
            "maxLength":100,
            "minLength":3,
            "type":"string"
        },
        "displayName":{
            "description":"A user-friendly name. Does not need to be unique, and it is changeable. Avoid entering confidential information.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "id":{
            "description":"The OCID of the volume attachment.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "instanceId":{
            "description":"The OCID of the instance the volume is attached to.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "isReadOnly":{
            "description":"Whether the attachment was created in read-only mode.",
            "type":"boolean"
        },
        "isShareable":{
            "description":"Whether the attachment should be created in shareable mode. If an attachment is created in shareable mode, then other instances can attach the same volume, provided that they also create their attachments in shareable mode. Only certain volume types can be attached in shareable mode. Defaults to false if not specified.",
            "type":"boolean"
        },
        "lifecycleState":{
            "description":"The current state of the volume attachment.",
            "enum":[
                "ATTACHING",
                "ATTACHED",
                "DETACHING",
                "DETACHED"
            ],
            "type":"string"
        },
        "timeCreated":{
            "description":"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 ",
            "format":"date-time",
            "type":"string"
        },
        "volumeId":{
            "description":"The OCID of the volume.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "isPvEncryptionInTransitEnabled":{
            "description":"Deprecated. Use isEncryptionInTransitEnabled instead.",
            "type":"boolean"
        },
        "isEncryptionInTransitEnabled":{
            "description":"Whether in-transit encryption for the data volume's attachment is enabled or not.",
            "type":"boolean"
        },
        "isMultipath":{
            "description":"Whether the Iscsi or Paravirtualized attachment is multipath or not, it is not applicable to NVMe attachment.",
            "type":"boolean"
        },
        "iscsiLoginState":{
            "description":"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.",
            "enum":[
                "UNKNOWN",
                "LOGGING_IN",
                "LOGIN_SUCCEEDED",
                "LOGIN_FAILED",
                "LOGGING_OUT",
                "LOGOUT_SUCCEEDED",
                "LOGOUT_FAILED"
            ],
            "type":"string"
        },
        "isVolumeCreatedDuringLaunch":{
            "description":"Flag indicating if this volume was created for the customer as part of a simplified launch. Used to determine whether the volume requires deletion on instance termination. ",
            "type":"boolean"
        }
    },
    "required":[
        "id",
        "attachmentType",
        "instanceId",
        "volumeId",
        "lifecycleState",
        "compartmentId",
        "availabilityDomain",
        "timeCreated"
    ],
    "type":"object"
}

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.

Body ()

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.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"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":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

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.

Body ()

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.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"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":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

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.

Body ()

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.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"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":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

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.

Body ()

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.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"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":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

Back to Top