Hosterra/scaleway-block-storage
Hosterra/scaleway-block-storage
1
0
Fork 0
Code Issues Pull requests Projects Releases 2 Packages Wiki Activity

Initial commit.

Browse source
This commit is contained in:
Pierre Lannoy 2025-03-03 16:35:54 +01:00
commit b6be743548
Signed by: Pierre Lannoy
GPG key ID: D27231EF87D53F31
93 changed files with 23955 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

12
docs/Model/CreateSnapshotRequest.md Normal file
View file

@ -0,0 +1,12 @@
# # CreateSnapshotRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**volume_id** | **string** | UUID of the volume to snapshot. | [optional]
**name** | **string** | Name of the snapshot. | [optional]
**project_id** | **string** | UUID of the project to which the volume and the snapshot belong. | [optional]
**tags** | **string[]** | List of tags assigned to the snapshot. | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

14
docs/Model/CreateVolumeRequest.md Normal file
View file

@ -0,0 +1,14 @@
# # CreateVolumeRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **string** | Name of the volume. |
**perf_iops** | **int** | The maximum IO/s expected, according to the different options available in stock (`5000 | 15000`). | [optional]
**project_id** | **string** | UUID of the project the volume belongs to. |
**from_empty** | [**\OpenAPI\Client\Model\CreateVolumeRequestFromEmpty**](CreateVolumeRequestFromEmpty.md) | | [optional]
**from_snapshot** | [**\OpenAPI\Client\Model\CreateVolumeRequestFromSnapshot**](CreateVolumeRequestFromSnapshot.md) | | [optional]
**tags** | **string[]** | List of tags assigned to the volume. | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

9
docs/Model/CreateVolumeRequestFromEmpty.md Normal file
View file

@ -0,0 +1,9 @@
# # CreateVolumeRequestFromEmpty
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**size** | **int** | Volume size in bytes, with a granularity of 1 GB (10^9 bytes). Must be compliant with the minimum (1 GB) and maximum (10 TB) allowed size. (in bytes) |
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

10
docs/Model/CreateVolumeRequestFromSnapshot.md Normal file
View file

@ -0,0 +1,10 @@
# # CreateVolumeRequestFromSnapshot
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**size** | **int** | Volume size in bytes, with a granularity of 1 GB (10^9 bytes). Must be compliant with the minimum (1 GB) and maximum (10 TB) allowed size. Size is optional and is used only if a resize of the volume is requested, otherwise original snapshot size will be used. (in bytes) | [optional]
**snapshot_id** | **string** | Source snapshot from which volume will be created. | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

10
docs/Model/ExportSnapshotToObjectStorageRequest.md Normal file
View file

@ -0,0 +1,10 @@
# # ExportSnapshotToObjectStorageRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**bucket** | **string** | Scaleway Object Storage bucket where the object is stored. | [optional]
**key** | **string** | The object key inside the given bucket. | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

14
docs/Model/ImportSnapshotFromObjectStorageRequest.md Normal file
View file

@ -0,0 +1,14 @@
# # ImportSnapshotFromObjectStorageRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**bucket** | **string** | Scaleway Object Storage bucket where the object is stored. | [optional]
**key** | **string** | The object key inside the given bucket. | [optional]
**name** | **string** | Name of the snapshot. | [optional]
**project_id** | **string** | UUID of the Project to which the volume and the snapshot belong. | [optional]
**tags** | **string[]** | List of tags assigned to the snapshot. | [optional]
**size** | **int** | Size of the snapshot. (in bytes) | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

10
docs/Model/ScalewayBlockV1alpha1ListSnapshotsResponse.md Normal file
View file

@ -0,0 +1,10 @@
# # ScalewayBlockV1alpha1ListSnapshotsResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**snapshots** | [**\OpenAPI\Client\Model\ScalewayBlockV1alpha1Snapshot[]**](ScalewayBlockV1alpha1Snapshot.md) | Paginated returned list of snapshots. | [optional]
**total_count** | **int** | Total number of snpashots in the project. | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

10
docs/Model/ScalewayBlockV1alpha1ListVolumeTypesResponse.md Normal file
View file

@ -0,0 +1,10 @@
# # ScalewayBlockV1alpha1ListVolumeTypesResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**volume_types** | [**\OpenAPI\Client\Model\ScalewayBlockV1alpha1VolumeType[]**](ScalewayBlockV1alpha1VolumeType.md) | Returns paginated list of volume-types. | [optional]
**total_count** | **int** | Total number of volume-types currently available in stock. | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

10
docs/Model/ScalewayBlockV1alpha1ListVolumesResponse.md Normal file
View file

@ -0,0 +1,10 @@
# # ScalewayBlockV1alpha1ListVolumesResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**volumes** | [**\OpenAPI\Client\Model\ScalewayBlockV1alpha1Volume[]**](ScalewayBlockV1alpha1Volume.md) | Paginated returned list of volumes. | [optional]
**total_count** | **int** | Total number of volumes in the project. | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

14
docs/Model/ScalewayBlockV1alpha1Reference.md Normal file
View file

@ -0,0 +1,14 @@
# # ScalewayBlockV1alpha1Reference
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **string** | UUID of the reference. (UUID format) | [optional]
**product_resource_type** | **string** | Type of resource to which the reference is associated. | [optional]
**product_resource_id** | **string** | UUID of the product resource it refers to (according to the product_resource_type). (UUID format) | [optional]
**created_at** | **\DateTime** | Creation date of the reference. (RFC 3339 format) | [optional]
**type** | **string** | Type of reference (link, exclusive, read_only). | [optional] [default to 'unknown_type']
**status** | **string** | Status of the reference. Statuses include `attaching`, `attached`, and `detaching`. | [optional] [default to 'unknown_status']
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

20
docs/Model/ScalewayBlockV1alpha1Snapshot.md Normal file
View file

@ -0,0 +1,20 @@
# # ScalewayBlockV1alpha1Snapshot
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **string** | UUID of the snapshot. (UUID format) | [optional]
**name** | **string** | Name of the snapshot. | [optional]
**parent_volume** | [**\OpenAPI\Client\Model\ScalewayBlockV1alpha1SnapshotParentVolume**](ScalewayBlockV1alpha1SnapshotParentVolume.md) | | [optional]
**size** | **int** | Size in bytes of the snapshot. (in bytes) | [optional]
**project_id** | **string** | UUID of the project the snapshot belongs to. (UUID format) | [optional]
**created_at** | **\DateTime** | Creation date of the snapshot. (RFC 3339 format) | [optional]
**updated_at** | **\DateTime** | Last modification date of the properties of a snapshot. (RFC 3339 format) | [optional]
**references** | [**\OpenAPI\Client\Model\ScalewayBlockV1alpha1Reference[]**](ScalewayBlockV1alpha1Reference.md) | List of the references to the snapshot. | [optional]
**status** | **string** | Current status of the snapshot (available, in_use, ...). | [optional] [default to 'unknown_status']
**tags** | **string[]** | List of tags assigned to the volume. | [optional]
**zone** | **string** | Snapshot zone. | [optional]
**class** | **string** | Storage class of the snapshot. | [optional] [default to 'unknown_storage_class']
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

12
docs/Model/ScalewayBlockV1alpha1SnapshotParentVolume.md Normal file
View file

@ -0,0 +1,12 @@
# # ScalewayBlockV1alpha1SnapshotParentVolume
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **string** | Parent volume UUID (volume from which the snapshot originates). (UUID format) | [optional]
**name** | **string** | Name of the parent volume. | [optional]
**type** | **string** | Volume type of the parent volume. | [optional]
**status** | **string** | Current status the parent volume. | [optional] [default to 'unknown_status']
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

22
docs/Model/ScalewayBlockV1alpha1Volume.md Normal file
View file

@ -0,0 +1,22 @@
# # ScalewayBlockV1alpha1Volume
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **string** | UUID of the volume. (UUID format) | [optional]
**name** | **string** | Name of the volume. | [optional]
**type** | **string** | Volume type. | [optional]
**size** | **int** | Volume size in bytes. (in bytes) | [optional]
**project_id** | **string** | UUID of the project to which the volume belongs. (UUID format) | [optional]
**created_at** | **\DateTime** | Creation date of the volume. (RFC 3339 format) | [optional]
**updated_at** | **\DateTime** | Last update of the properties of a volume. (RFC 3339 format) | [optional]
**references** | [**\OpenAPI\Client\Model\ScalewayBlockV1alpha1Reference[]**](ScalewayBlockV1alpha1Reference.md) | List of the references to the volume. | [optional]
**parent_snapshot_id** | **string** | When a volume is created from a snapshot, is the UUID of the snapshot from which the volume has been created. (UUID format) | [optional]
**status** | **string** | Current status of the volume (available, in_use, ...). | [optional] [default to 'unknown_status']
**tags** | **string[]** | List of tags assigned to the volume. | [optional]
**zone** | **string** | Volume zone. | [optional]
**specs** | [**\OpenAPI\Client\Model\ScalewayBlockV1alpha1VolumeSpecs**](ScalewayBlockV1alpha1VolumeSpecs.md) | | [optional]
**last_detached_at** | **\DateTime** | Last time the volume was detached. (RFC 3339 format) | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

10
docs/Model/ScalewayBlockV1alpha1VolumeSpecs.md Normal file
View file

@ -0,0 +1,10 @@
# # ScalewayBlockV1alpha1VolumeSpecs
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**perf_iops** | **int** | The maximum IO/s expected, according to the different options available in stock (`5000 | 15000`). | [optional]
**class** | **string** | The storage class of the volume. | [optional] [default to 'unknown_storage_class']
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

12
docs/Model/ScalewayBlockV1alpha1VolumeType.md Normal file
View file

@ -0,0 +1,12 @@
# # ScalewayBlockV1alpha1VolumeType
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **string** | Volume type. | [optional]
**pricing** | [**\OpenAPI\Client\Model\ScalewayBlockV1alpha1VolumeTypePricing**](ScalewayBlockV1alpha1VolumeTypePricing.md) | | [optional]
**snapshot_pricing** | [**\OpenAPI\Client\Model\ScalewayBlockV1alpha1VolumeTypeSnapshotPricing**](ScalewayBlockV1alpha1VolumeTypeSnapshotPricing.md) | | [optional]
**specs** | [**\OpenAPI\Client\Model\ScalewayBlockV1alpha1VolumeTypeSpecs**](ScalewayBlockV1alpha1VolumeTypeSpecs.md) | | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

11
docs/Model/ScalewayBlockV1alpha1VolumeTypePricing.md Normal file
View file

@ -0,0 +1,11 @@
# # ScalewayBlockV1alpha1VolumeTypePricing
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**currency_code** | **string** | | [optional]
**units** | **int** | | [optional]
**nanos** | **int** | | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

11
docs/Model/ScalewayBlockV1alpha1VolumeTypeSnapshotPricing.md Normal file
View file

@ -0,0 +1,11 @@
# # ScalewayBlockV1alpha1VolumeTypeSnapshotPricing
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**currency_code** | **string** | | [optional]
**units** | **int** | | [optional]
**nanos** | **int** | | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

10
docs/Model/ScalewayBlockV1alpha1VolumeTypeSpecs.md Normal file
View file

@ -0,0 +1,10 @@
# # ScalewayBlockV1alpha1VolumeTypeSpecs
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**perf_iops** | **int** | The maximum IO/s expected, according to the different options available in stock (`5000 | 15000`). | [optional]
**class** | **string** | The storage class of the volume. | [optional] [default to 'unknown_storage_class']
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

10
docs/Model/UpdateSnapshotRequest.md Normal file
View file

@ -0,0 +1,10 @@
# # UpdateSnapshotRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **string** | When defined, is the name of the snapshot. | [optional]
**tags** | **string[]** | List of tags assigned to the snapshot. | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

12
docs/Model/UpdateVolumeRequest.md Normal file
View file

@ -0,0 +1,12 @@
# # UpdateVolumeRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **string** | When defined, is the new name of the volume. | [optional]
**size** | **int** | Optional field for increasing the size of a volume (size must be equal or larger than the current one). Size in bytes of the volume, with a granularity of 1 GB (10^9 bytes). Must be compliant with the minimum (1GB) and maximum (10TB) allowed size. (in bytes) | [optional]
**tags** | **string[]** | List of tags assigned to the volume. | [optional]
**perf_iops** | **int** | The maximum IO/s expected, according to the different options available in stock (`5000 | 15000`). The selected value must be available for the volume's current storage class. | [optional]
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)