Skip to content

Latest commit

 

History

History
413 lines (216 loc) · 12.2 KB

BlockStorageApi.md

File metadata and controls

413 lines (216 loc) · 12.2 KB

\BlockStorageApi

All URIs are relative to https://api-ch-gva-2.exoscale.com/v2

Method HTTP request Description
attach_block_storage_volume_to_instance PUT /block-storage/{id}:attach Attach block storage volume to an instance
create_block_storage_snapshot POST /block-storage/{id}:create-snapshot Create a block storage snapshot
create_block_storage_volume POST /block-storage Create a block storage volume
delete_block_storage_snapshot DELETE /block-storage-snapshot/{id} Delete a block storage snapshot, data will be unrecoverable
delete_block_storage_volume DELETE /block-storage/{id} Delete a block storage volume, data will be unrecoverable
detach_block_storage_volume PUT /block-storage/{id}:detach Detach block storage volume
get_block_storage_snapshot GET /block-storage-snapshot/{id} Retrieve block storage snapshot details
get_block_storage_volume GET /block-storage/{id} Retrieve block storage volume details
list_block_storage_snapshots GET /block-storage-snapshot List block storage snapshots
list_block_storage_volumes GET /block-storage List block storage volumes
resize_block_storage_volume PUT /block-storage/{id}:resize-volume Resize a block storage volume
update_block_storage_snapshot PUT /block-storage-snapshot/{id} Update block storage volume snapshot
update_block_storage_volume PUT /block-storage/{id} Update block storage volume

attach_block_storage_volume_to_instance

models::Operation attach_block_storage_volume_to_instance(id, attach_block_storage_volume_to_instance_request) Attach block storage volume to an instance

Parameters

Name Type Description Required Notes
id uuid::Uuid [required]
attach_block_storage_volume_to_instance_request AttachBlockStorageVolumeToInstanceRequest [required]

Return type

models::Operation

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_block_storage_snapshot

models::Operation create_block_storage_snapshot(id, create_block_storage_snapshot_request) Create a block storage snapshot

Parameters

Name Type Description Required Notes
id uuid::Uuid [required]
create_block_storage_snapshot_request CreateBlockStorageSnapshotRequest [required]

Return type

models::Operation

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_block_storage_volume

models::Operation create_block_storage_volume(create_block_storage_volume_request) Create a block storage volume

Parameters

Name Type Description Required Notes
create_block_storage_volume_request CreateBlockStorageVolumeRequest [required]

Return type

models::Operation

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_block_storage_snapshot

models::Operation delete_block_storage_snapshot(id) Delete a block storage snapshot, data will be unrecoverable

Parameters

Name Type Description Required Notes
id uuid::Uuid [required]

Return type

models::Operation

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_block_storage_volume

models::Operation delete_block_storage_volume(id) Delete a block storage volume, data will be unrecoverable

Parameters

Name Type Description Required Notes
id uuid::Uuid [required]

Return type

models::Operation

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

detach_block_storage_volume

models::Operation detach_block_storage_volume(id) Detach block storage volume

Parameters

Name Type Description Required Notes
id uuid::Uuid [required]

Return type

models::Operation

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_block_storage_snapshot

models::BlockStorageSnapshot get_block_storage_snapshot(id) Retrieve block storage snapshot details

Parameters

Name Type Description Required Notes
id uuid::Uuid [required]

Return type

models::BlockStorageSnapshot

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_block_storage_volume

models::BlockStorageVolumeDetails get_block_storage_volume(id) Retrieve block storage volume details

Parameters

Name Type Description Required Notes
id uuid::Uuid [required]

Return type

models::BlockStorageVolumeDetails

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_block_storage_snapshots

models::ListBlockStorageSnapshots200Response list_block_storage_snapshots() List block storage snapshots

Parameters

This endpoint does not need any parameter.

Return type

models::ListBlockStorageSnapshots200Response

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_block_storage_volumes

models::ListBlockStorageVolumes200Response list_block_storage_volumes(instance_id) List block storage volumes

Parameters

Name Type Description Required Notes
instance_id Option<uuid::Uuid>

Return type

models::ListBlockStorageVolumes200Response

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

resize_block_storage_volume

models::BlockStorageVolume resize_block_storage_volume(id, resize_block_storage_volume_request) Resize a block storage volume

This operation resizes a Block storage volume. Note: the volume can only grow, cannot be shrunk.

Parameters

Name Type Description Required Notes
id uuid::Uuid [required]
resize_block_storage_volume_request ResizeBlockStorageVolumeRequest [required]

Return type

models::BlockStorageVolume

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_block_storage_snapshot

models::Operation update_block_storage_snapshot(id, update_block_storage_snapshot_request) Update block storage volume snapshot

Parameters

Name Type Description Required Notes
id uuid::Uuid [required]
update_block_storage_snapshot_request UpdateBlockStorageSnapshotRequest [required]

Return type

models::Operation

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_block_storage_volume

models::Operation update_block_storage_volume(id, update_block_storage_volume_request) Update block storage volume

Parameters

Name Type Description Required Notes
id uuid::Uuid [required]
update_block_storage_volume_request UpdateBlockStorageVolumeRequest [required]

Return type

models::Operation

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]