REST API for Oracle Cloud Infrastructure Compute Classic

Retrieve Details of a Storage Attachment

get

/storage/attachment/{name}

Retrieves details of the specified storage attachment.

Required Role: To complete this task, you must have the Compute_Monitor or Compute_Operations role. If this role isn't assigned to you or you're not sure, then ask your system administrator to ensure that the role is assigned to you in Oracle Cloud My Services. See Modifying User Roles in Managing and Monitoring Oracle Cloud.

Request

Supported Media Types

application/oracle-compute-v3+json

Path Parameters

name: string

Multipart name of the object.

Header Parameters

Cookie: string

The Cookie: header must be included with every request to the service. It must be set to the value of the set-cookie header in the response received to the POST /authenticate/ call.

Response

Supported Media Types

application/oracle-compute-v3+json

200 Response

OK. See Status Codes for information about other possible HTTP status codes.

Headers

set-cookie: string

The cookie value is returned if the session is extended

Root Schema : StorageAttachment-response

Type: object

Show Source

account(optional): string

Shows the default account for your identity domain.
hypervisor(optional): string

Hypervisor type to which this volume was attached to.
index(optional): integer

Index number for the volume. The allowed range is 1-10. The index determines the device name by which the volume is exposed to the instance. Index 0 is allocated to the temporary boot disk, /dev/xvda. An attachment with index 1 is exposed to the instance as /dev/xvdb, an attachment with index 2 is exposed as /dev/xvdc, and so on.
instance_name(optional): string

Multipart name of the instance attached to the storage volume.
name(optional): string

Name of this attachment, generated by the server.
readonly(optional): boolean

When set to true, it indicates that the volume is a read-only storage volume.
state(optional): string

Specify one of the following states of the storage attachment:
attaching: The storage attachment is in the process of attaching to the instance.
attached: The storage attachment is attached to the instance.
detaching: The storage attachment is in the process of detaching from the instance.
unavailable: The storage attachment is unavailable.
unknown: The state of the storage attachment is not known.
storage_volume_name(optional): string

Three part name (/Compute-identity_domain/user/object_name) of the storage volume that is attached to the instance.
uri(optional): string

Uniform Resource Identifier

{
    "properties":{
        "account":{
            "type":"string",
            "description":"Shows the default account for your identity domain."
        },
        "hypervisor":{
            "type":"string",
            "description":"Hypervisor type to which this volume was attached to."
        },
        "index":{
            "type":"integer",
            "description":"<p>Index number for the volume. The allowed range is 1-10. The index determines the device name by which the volume is exposed to the instance. Index 0 is allocated to the temporary boot disk, /dev/xvda. An attachment with index 1 is exposed to the instance as /dev/xvdb, an attachment with index 2 is exposed as /dev/xvdc, and so on."
        },
        "instance_name":{
            "type":"string",
            "description":"Multipart name of the instance attached to the storage volume."
        },
        "name":{
            "type":"string",
            "description":"Name of this attachment, generated by the server."
        },
        "readonly":{
            "type":"boolean",
            "description":"When set to <code>true</code>, it indicates that the volume is a read-only storage volume."
        },
        "state":{
            "type":"string",
            "description":"<p>Specify one of the following states of the storage attachment:<p><code>attaching</code>: The storage attachment is in the process of attaching to the instance.<p><code>attached</code>: The storage attachment is attached to the instance.<p><code>detaching</code>: The storage attachment is in the process of detaching from the instance.<p><code>unavailable</code>: The storage attachment is unavailable.<p><code>unknown</code>: The state of the storage attachment is not known."
        },
        "storage_volume_name":{
            "type":"string",
            "description":"Three part name (<code>/Compute-<em>identity_domain</em>/<em>user</em>/<em>object_name</em></code>) of the storage volume that is attached to the instance."
        },
        "uri":{
            "type":"string",
            "description":"Uniform Resource Identifier"
        }
    }
}

Examples

cURL Command

The following example shows how to view details of a storage attachment by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.

Enter the command on a single line. Line breaks are used in this example for readability.

curl -X GET 
     -H "Cookie: $COMPUTE_COOKIE"
     -H "Accept: application/oracle-compute-v3+json"
     https://api-z999.compute.us0.oraclecloud.com/storage/attachment/Compute-acme/jack.jones@example.com/a6462ba5-5933-41a1-b853-fcfcb421cb07/5fd18f4a-2ac2-4548-a0cf-57774c024742/a7fb4550-df19-497c-a19f-44fc176e1fc2

COMPUTE_COOKIE is the name of the variable in which you stored the authentication cookie earlier. For information about retrieving the authentication cookie and storing it in a variable, see Authentication.
api-z999.compute.us0.oraclecloud.com is an example REST endpoint URL. Change this value to the REST endpoint URL of your Compute Classic site. For information about finding out REST endpoint URL for your site, see Send Requests.
acme and jack.jones@example.com are example values. Replace acme with the identity domain ID of your Compute Classic account, and jack.jones@example.com with your user name.

Example of Response Body

The following example shows the response body in JSON format.

Some lines may be truncated with ellipses (...) for readability.

{
  "index": 1,
  "account": null,
  "storage_volume_name": "/Compute-acme/jack.jones@example.com/vol1",
  "hypervisor": null,
  "uri": "https://api-z999.compute.us0.oraclecloud.com/storage/attachment/Compute-acme/jack.jones@example.com/a6462b...cb07/5fd18f...4742/a7fb45...e1fc2",
  "instance_name": "/Compute-acme/jack.jones@example.com/a6462ba5-5933-41a1-b853-fcfcb421cb07/5fd18f4a-2ac2-4548-a0cf-57774c024742",
  "state": "attached",
  "readonly": false,
  "name": "/Compute-acme/jack.jones@example.com/a6462ba5-5933-41a1-b853-fcfcb421cb07/5fd18f4a-2ac2-4548-a0cf-57774c024742/a7fb4550-df19-497c-a19f-44fc176e1fc2"
}