The IDrive® Compute service has been discontinued since 15 August 2023.

Skip to main content

Volumes

  • Updated

An IDrive Compute block volume is a detachable block storage device, similar to a USB hard drive that can be used to store data. You can attach a volume to only one instance.

List of Volumes

GET https://la3.volumes.api.idrivecompute.io/v3/{project_id}/volumes/detail
Authorizations X-Auth-Token

Request Samples

curl -H "X-Auth-Token: ${TOKEN}" \
    -X GET \
    https://la3.volumes.api.idrivecompute.io/v3/
    b88176b3de3f4771aa183e8bd7e1edc7/volumes/detail

Response Samples

{
  "volumes": [
    {
      "id": "0760b47e-116c-4250-947c-9f6a2755d817",
      "links": [
        {
          "href": "http://la3.volumes.api.idrivecompute.io/v3/
          b88176b3de3f4771aa183e8bd7e1edc7/volumes/
          0760b47e-116c-4250-947c-9f6a2755d817","rel": "self"
        },
        {
          "href": "http://la3.volumes.api.idrivecompute.io/
          b88176b3de3f4771aa183e8bd7e1edc7/volumes/
          0760b47e-116c-4250-947c-9f6a2755d817","rel": "bookmark"
        }
      ],
      "name": "myvolume"
    },
    {
      "id": "365161bd-e6cf-4a49-81cd-a5c94057688e",
      "links": [
        {
          "href": "http://la3.volumes.api.idrivecompute.io/v3/
          b88176b3de3f4771aa183e8bd7e1edc7/volumes/
          365161bd-e6cf-4a49-81cd-a5c94057688e","rel": "self"
        },
        {
          "href": "http://la3.volumes.api.idrivecompute.io/
          b88176b3de3f4771aa183e8bd7e1edc7/volumes/
          365161bd-e6cf-4a49-81cd-a5c94057688e","rel": "bookmark"
        }
      ],
      "name": "myvolume3"
    },
    {
      "id": "63ce6943-6977-4c5c-b4d5-16bf3df48593",
      "links": [
        {
          "href": "http://la3.volumes.api.idrivecompute.io/v3/
          b88176b3de3f4771aa183e8bd7e1edc7/volumes/
          63ce6943-6977-4c5c-b4d5-16bf3df48593","rel": "self"
        },
        {
          "href": "http://la3.volumes.api.idrivecompute.io/
          b88176b3de3f4771aa183e8bd7e1edc7/volumes/
          63ce6943-6977-4c5c-b4d5-16bf3df48593","rel": "bookmark"
        }
      ],
      "name": "myvolume2"
    }
  ]
}

 

Create Volume

POST https://la3.volumes.api.idrivecompute.io/v3/{project_id}/volumes
Authorizations X-Auth-Token

Request Samples

curl -H "X-Auth-Token: ${TOKEN}" \
    -H "Content-Type: application/json" \
    -X POST \
    -d "{
      "volume": {
        "size": 5,
        "name": "myvolume"
      }
    }" \
  https://la3.volumes.api.idrivecompute.io/v3/
  b88176b3de3f4771aa183e8bd7e1edc7/volumes

Response Samples

{
  "volume": {
    "status": "creating",
    "user_id": "191931bc755f410784fe42594c8e588d",
    "attachments": [],
    "links": [
      {
        "href": "http://la3.volumes.api.idrivecompute.io/v3/
        b88176b3de3f4771aa183e8bd7e1edc7/volumes/
        0426ad16-27ee-4cc9-a2b2-bb80a5e4f6e0","rel": "self"
      },
      {
        "href": "http://la3.volumes.api.idrivecompute.io/
        b88176b3de3f4771aa183e8bd7e1edc7/volumes/
        0426ad16-27ee-4cc9-a2b2-bb80a5e4f6e0","rel": "bookmark"
      }
    ],
    "availability_zone": "nova",
    "bootable": "false",
    "encrypted": false,
    "created_at": "2022-10-06T07:49:19.000000",
    "description": null,
    "updated_at": null,
    "volume_type": "__DEFAULT__",
    "name": "myvolume",
    "replication_status": null,
    "consistencygroup_id": null,
    "source_volid": null,
    "snapshot_id": null,
    "multiattach": false,
    "metadata": {},
    "id": "0426ad16-27ee-4cc9-a2b2-bb80a5e4f6e0",
    "size": 5
  }
}

 

Show Volume

GET https://la3.volumes.api.idrivecompute.io/v3/{project_id}/volumes/{volume_id}
Authorization X-Auth-Token

Request Samples

curl -H "X-Auth-Token: ${TOKEN}" \
    -X GET \
    https://la3.volumes.api.idrivecompute.io/v3/
    b88176b3de3f4771aa183e8bd7e1edc7/volumes/
    721c29a1-4ecf-4ce7-aecf-67aaa23e43fc

Response Samples

{
  "volumes": [
    {
      "status": "available",
      "user_id": "191931bc755f410784fe42594c8e588d",
      "attachments": [],
      "links": [
        {
          "href": "http://la3.volumes.api.idrivecompute.io/v3/
          b88176b3de3f4771aa183e8bd7e1edc7/volumes/
          721c29a1-4ecf-4ce7-aecf-67aaa23e43fc","rel": "self"
        },
        {
          "href": "http://la3.volumes.api.idrivecompute.io/
          b88176b3de3f4771aa183e8bd7e1edc7/volumes/
          721c29a1-4ecf-4ce7-aecf-67aaa23e43fc","rel": "bookmark"
        }
      ],
      "availability_zone": "nova",
      "bootable": "false",
      "encrypted": false,
      "created_at": "2022-10-06T08:23:56.000000",
      "description": null,
      "os-vol-tenant-attr:tenant_id": "b88176b3de3f4771aa183e8bd7e1edc7",
      "updated_at": "2022-10-06T08:23:57.000000",
      "volume_type": "__DEFAULT__",
      "name": "myvolume",
      "replication_status": null,
      "consistencygroup_id": null,
      "source_volid": null,
      "snapshot_id": null,
      "multiattach": false,
      "metadata": {},
      "id": "721c29a1-4ecf-4ce7-aecf-67aaa23e43fc",
      "size": 5
    }
  ]
}

 

Update Volume

PUT

https://la3.volumes.api.idrivecompute.io/v3/{project_id}/volumes/{volume_id}

Authorizations

 X-Auth-Token

Request Samples

curl -H "X-Auth-Token: ${TOKEN}" \
    -H "Content-Type: application/json" \
    -X POST \
    -d "{
      "volume": {
        "display_name": "Volume-002"
      }
    }" \
    https://la3.volumes.api.idrivecompute.io/v3/
    b88176b3de3f4771aa183e8bd7e1edc7/volumes/
    721c29a1-4ecf-4ce7-aecf-67aaa23e43fc

Response Samples

{
  "volume": {
    "status": "available",
    "user_id": "191931bc755f410784fe42594c8e588d",
    "attachments": [],
    "links": [
      {
        "href": "http://la3.volumes.api.idrivecompute.io/v3/b88176b3de3f4771aa183e8bd7e1edc7/volumes/bcfc2d4b-8ea6-481c-8959-0084c45500e9",
        "rel": "self"
      },
      {
        "href": "http://la3.volumes.api.idrivecompute.io/b88176b3de3f4771aa183e8bd7e1edc7/volumes/bcfc2d4b-8ea6-481c-8959-0084c45500e9",
        "rel": "bookmark"
      }
    ],
    "availability_zone": "nova",
    "bootable": "false",
    "encrypted": false,
    "created_at": "2022-10-10T10:27:26.000000",
    "description": null,
    "updated_at": "2022-10-12T12:03:50.000000",
    "volume_type": "__DEFAULT__",
    "name": "Volume-002",
    "replication_status": null,
    "consistencygroup_id": null,
    "source_volid": null,
    "snapshot_id": null,
    "multiattach": false,
    "metadata": {},
    "id": "bcfc2d4b-8ea6-481c-8959-0084c45500e9",
    "size": 5
  }
}

 

Extend Volume

POST

https://la3.volumes.api.idrivecompute.io/v3/{project_id}/volumes/{volume_id}/action

Authorizations

 X-Auth-Token

Request Samples

curl -H "X-Auth-Token: ${TOKEN}" \
    -H "Content-Type: application/json" \
    -X POST \
    -d "{
      "os-extend": {
        "new_size": 24
      }
    }" \
    https://la3.volumes.api.idrivecompute.io/v3/
    b88176b3de3f4771aa183e8bd7e1edc7/volumes/
    721c29a1-4ecf-4ce7-aecf-67aaa23e43fc/action

Response Samples

The response is empty and returns the HTTP 202 response code in the case of a successful request.

 

Delete Volume

DELETE https://la3.volumes.api.idrivecompute.io/v3/{project_id}/volumes/{volume_id}
Authorization X-Auth-Token

Request Samples

curl -H "X-Auth-Token: ${TOKEN}" \
    -X DELETE \
    https://la3.volumes.api.idrivecompute.io/v3/
    b88176b3de3f4771aa183e8bd7e1edc7/volumes/
    721c29a1-4ecf-4ce7-aecf-67aaa23e43fc

Response Samples

The response is empty and returns the HTTP 204 response code in the case of a successful request.

Attach Volume

POST

https://la3.volumes.api.idrivecompute.io/v3/{project_id}/volumes/{volume_id}/action
Authorizations X-Auth-Token

Request Samples

curl -H "X-Auth-Token: ${TOKEN}" \
    -H "Content-Type: application/json" \
    -X POST \
    -d "{
      "os-attach": {
        "instance_uuid": "13ee2ee2-0fa3-44be-b1ae-d043b31cf694",
        "mountpoint": "/dev/vdc"
      }
    }" \
    https://la3.volumes.api.idrivecompute.io/v3/
    b88176b3de3f4771aa183e8bd7e1edc7/volumes/
    73319ab4-f565-430e-b2af-2c0490e80fd0/action

Response Samples

The response is empty and returns the HTTP 202 response code in the case of a successful request.

 

Detach Volume

POST

https://la3.volumes.api.idrivecompute.io/v3/{project_id}/volumes/{volume_id}/action
Authorizations X-Auth-Token

Request Samples

curl -H "X-Auth-Token: ${TOKEN}" \
    -H "Content-Type: application/json" \
    -X POST \
    -d "{
      "os-detach": {}
    }" \
    https://la3.volumes.api.idrivecompute.io/v3/
    b88176b3de3f4771aa183e8bd7e1edc7/volumes/
    73319ab4-f565-430e-b2af-2c0490e80fd0/action

 

Response Samples

The response is empty and returns the HTTP 202 response code in the case of a successful request.

 

List of Volume Backups

GET https://la3.volumes.api.idrivecompute.io/v3/{project_id}/backups/detail
Authorizations X-Auth-Token

Request Samples

curl -H "X-Auth-Token: ${TOKEN}" \
    -x GET \
    https://tx3.volumes.api.idrivecompute.io/v3/
    b88176b3de3f4771aa183e8bd7e1edc7/backups/detail

Response Samples

{
  "backups": [
    {
      "status": "available",
      "object_count": 1,
      "container": "c3/96/c39631f4-b5b1-44a8-bcd6-3b5ab51d5737",
      "name": "v1-backup",
      "links": [
        {
          "href": "http://la3.volumes.api.idrivecompute.io/v3/
          b88176b3de3f4771aa183e8bd7e1edc7/backups/
          c39631f4-b5b1-44a8-bcd6-3b5ab51d5737","rel": "self"
        },
        {
          "href": "http://la3.volumes.api.idrivecompute.io/
          b88176b3de3f4771aa183e8bd7e1edc7/backups/
          c39631f4-b5b1-44a8-bcd6-3b5ab51d5737","rel": "bookmark"
        }
      ],
      "availability_zone": "nova",
      "created_at": "2022-03-05T10:32:50.000000",
      "description": "Daily backup",
      "updated_at": "2022-03-05T10:35:03.000000",
      "data_timestamp": "2022-03-05T10:32:50.000000",
      "has_dependent_backups": false,
      "snapshot_id": null,
      "volume_id": "e553de6b-64e4-41e1-ab20-3d208a1d4a61",
      "fail_reason": null,
      "is_incremental": false,
      "id": "c39631f4-b5b1-44a8-bcd6-3b5ab51d5737",
      "size": 1
    },
    {
      "status": "available",
      "object_count": 1,
      "container": "62/16/62169e6e-76ed-40d3-a532-ee8b0aadc7f6",
      "name": "v2-backup",
      "links": [
        {
          "href": "http://la3.volumes.api.idrivecompute.io/v3/
          b88176b3de3f4771aa183e8bd7e1edc7/backups/
          62169e6e-76ed-40d3-a532-ee8b0aadc7f6","rel": "self"
        },
        {
          "href": "http://la3.volumes.api.idrivecompute.io/
          b88176b3de3f4771aa183e8bd7e1edc7/backups/
          62169e6e-76ed-40d3-a532-ee8b0aadc7f6","rel": "bookmark"
        }
      ],
      "availability_zone": "nova",
      "created_at": "2022-03-05T10:32:41.000000",
      "description": "Daily backup",
      "updated_at": "2022-03-05T10:36:00.000000",
      "data_timestamp": "2022-03-05T10:32:41.000000",
      "has_dependent_backups": false,
      "snapshot_id": null,
      "volume_id": "80312f29-8966-42d4-a52e-a68e9c749f2b",
      "fail_reason": null,
      "is_incremental": false,
      "id": "62169e6e-76ed-40d3-a532-ee8b0aadc7f6",
      "size": 1
    }
  ]
}

 

Create Volume Backup

POST https://la3.volumes.api.idrivecompute.io/v3/{project_id}/backups
Authorizations X-Auth-Token

Request Samples

curl -H "X-Auth-Token: ${TOKEN}" \
    -H "Content-Type: application/json" \
    -X POST \
    -d "{
      "backup": {
        "name": "backup001",
        "volume_id": "73319ab4-f565-430e-b2af-2c0490e80fd0",
        "incremental": false
      }
    }" \
    https://la3.volumes.api.idrivecompute.io/v3/
    b88176b3de3f4771aa183e8bd7e1edc7/backups

Response Samples

The response is empty and returns the HTTP 202 response code in the case of a successful request.

 

Restore Volume Backup

POST https://la3.volumes.api.idrivecompute.io/v3/{project_id}/backups/{backup_id}/restore
Authorizations X-Auth-Token

Request Samples

curl -H "X-Auth-Token: ${TOKEN}" \
    -H "Content-Type: application/json" \
    -X POST \
    -d "{
      "restore": {
        "name": "restore001",
        "volume_id": "73319ab4-f565-430e-b2af-2c0490e80fd0"
      }
    }" \
    https://la3.volumes.api.idrivecompute.io/v3/
    b88176b3de3f4771aa183e8bd7e1edc7/backups/73319ab4-f565-430e-b2af-2c0490e80fd0/restore

Response Samples

The response is empty and returns the HTTP 202 response code in the case of a successful request.

 

Update Volume Backup

PUT https://la3.volumes.api.idrivecompute.io/v3/{project_id}/backups/{backup_id}
Authorizations X-Auth-Token

Request Samples

curl -H "X-Auth-Token: ${TOKEN}" \
    -H "Content-Type: application/json" \
    -H "OpenStack-API-Version: volume 3.9" \
    -X PUT \
    -d "{
      "backup": {
        "name": "backup002"
      }
    }" \
    https://la3.volumes.api.idrivecompute.io/v3/
    b88176b3de3f4771aa183e8bd7e1edc7/backups/73319ab4-f565-430e-b2af-2c0490e80fd0

Response Samples

{
  "backup": {
    "id": "9f721d86-ab1a-4a31-b824-20df178cf1e6",
    "links": [
      {
        "href": "http://sea1.volumes.api.idrivecompute.io/v3/b88176b3de3f4771aa183e8bd7e1edc7/backups/9f721d86-ab1a-4a31-b824-20df178cf1e6",
        "rel": "self"
      },
      {
        "href": "http://sea1.volumes.api.idrivecompute.io/b88176b3de3f4771aa183e8bd7e1edc7/backups/9f721d86-ab1a-4a31-b824-20df178cf1e6",
        "rel": "bookmark"
      }
    ],
    "name": "backup002"
  }
}

 

Delete Volume Backup

DELETE

https://la3.volumes.api.idrivecompute.io/v3/{project_id}/backups/{backup_id}
Authorizations X-Auth-Token

Request Samples

curl -H "X-Auth-Token: ${TOKEN}" \
    -X DELETE \
    https://la3.volumes.api.idrivecompute.io/v3/
    b88176b3de3f4771aa183e8bd7e1edc7/backups/
    73319ab4-f565-430e-b2af-2c0490e80fd0

Response Samples

The response is empty and returns the HTTP 202 response code in the case of a successful request.