Page tree
Skip to end of metadata
Go to start of metadata

API Essentials

API Key Generation

Autoscaling

Backups

Credit

DNS

Firewall Rules

Flex Cloud VM Control

Getting Started with Superb Flex Cloud

IP Addresses

Logs

Network Interfaces

Recipes

SSH Keys

Templates

Test Route

Troubleshooting API Issues

Viewing Activity Logs

Virtual Server Operating Systems

Virtual Servers

VS Disks

GET /virtual_machines/:virtual_machine_id/disks

Gets a list of disks for the specified server

Sections:

Response Parameters

add_to_freebsd_fstab - true, if this disk is added to the FreeBSD fstab, otherwise false

add_to_linux_fstab - true, if this disk is added to Linux fstab, otherwise false

built - true if the disk is built, otherwise false

created_at - the date when the disk was created in the [YYYY][MM][DD]T[hh][mm][ss]Z format

updated_at - the date when the disk was updated in the [YYYY][MM][DD]T[hh][mm][ss]Z format

data_store_id - the ID of the data store this disk is located

disk_size - disk size in GB

disk_vm_number - the number of virtual servers using this disk

file_system - disk filesystem (ext3 or ext4)

id - the disk ID

identifier - disk identifier

is_swap - true if this is a swap disk, otherwise false

label - disk's label

locked - true if the disk is locked, otherwise false

mount_point - disk mount point.

primary - true if the disk is primary. Otherwise false.

virtual_machine_id - the ID of the virtual server using this disk

volume_id - data store ID

has_autobackups - true if the disk has automatic backups set up, otherwise false.

SolidFire - related parameters:

iqn - volume ISCSI quialified name

burst_bw - maximum bandwidth allowed set in MB/sec

max_bw -maximum bandwidth allowed set in MB/sec

JSON Request example

curl -i -X GET -H 'Accept: application/json' -H 'Content-type: application/json' -u user:userpass --url <api_url>/virtual_machines/:virtual_machine_id/disks.json

JSON Response

 [
    {
        "disk": {
            "add_to_freebsd_fstab": null,
            "add_to_linux_fstab": true,
            "built": true,
            "burst_bw": 1000,
            "burst_iops": 15000,
            "created_at": "2015-08-11T01:07:12+00:00",
            "data_store_id": 2,
            "disk_size": 2,
            "disk_vm_number": 1,
            "file_system": "swap",
            "id": 776,
            "identifier": "1qt8ejm0cip2fz",
            "iqn": null,
            "is_swap": true,
            "label": "Disk#776",
            "locked": false,
            "max_bw": 1000,
            "max_iops": 15000,
            "min_iops": 100,
            "mount_point": null,
            "primary": false,
            "updated_at": "2015-08-13T02:30:38+00:00",
            "virtual_machine_id": 488,
            "volume_id": null,
            "has_autobackups": false
        }
    }
]

XML Request example

 curl -i -X GET -H 'Accept: application/json' -H 'Content-type: application/json' -u user:userpass --url <api_url>/virtual_machines/:virtual_machine_id/disks.xml

XML Response example

 <?xml version="1.0" encoding="UTF-8"?>
<disks type="array">
<disk>
<add_to_freebsd_fstab nil="true"/>
<add_to_linux_fstab nil="true"/>
<built type="boolean">true</built>
<burst_bw type="integer">1000</burst_bw>
<bus nil="true"/>
<created_at type="datetime">2013-01-21T12:59:06+02:00</created_at>
<data_store_id type="integer">6</data_store_id>
<disk_size type="integer">60</disk_size>
<disk_vm_number type="integer">0</disk_vm_number>
<file_system type="symbol">ext3</file_system>
<id type="integer">868</id>
<identifier>wtqpz628vbdasx</identifier>
<iqn nil="true"/>
<is_swap type="boolean">false</is_swap>
<label nil="true"/>
<locked type="boolean">false</locked>
<max_bw type="integer">1000</max_bw>
<mount_point nil="true"/>
<primary type="boolean">true</primary>
<updated_at type="datetime">2013-01-21T13:00:18+02:00</updated_at>
<virtual_machine_id type="integer">458</virtual_machine_id>
<volume_id nil="true"/>
<has_autobackups type="boolean">false</has_autobackups>
</disk>
</disks>
  • No labels