compute
volume

Retrieve a volume

get/compute/{connection_id}/volume/{id}

Request

  • Base URL: http://api.unified.to
  • URL: http://api.unified.to/compute/{connection_id}/volume/{id}
  • Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

idstring required

ID of the Volume

Query parameters

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Response

Successful

idstring

Unique identifier for the volume

created_atstring date-time

When the volume was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

When the volume was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

namestring

Display name of the volume

type'STANDARD' | 'HIGH_PERFORMANCE' | 'SHARED' | 'LOCAL' | 'OTHER'

The kind of volume

status'CREATING' | 'AVAILABLE' | 'IN_USE' | 'DELETING' | 'ERROR' | 'OTHER'

Normalized volume status

size_mbnumber

Provisioned size in MiB

used_mbnumber

Used space in MiB

region_idstring

The region the volume lives in

availability_zonestring

The availability zone within the region, where the vendor places volumes per zone

instance_idsstring[]

Instances the volume is mounted on

rawunknown

Changes

No recorded changes to this operation across all 1 revision of this API.