Scaleway logo
Block Storage API

google.type.Money

currency_code
​string
units
​integer · int64
nanos
​integer · int32

scaleway.block.v1.CreateVolumeRequest.FromEmpty

size
​integer · uint64 · required

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)

scaleway.block.v1.CreateVolumeRequest.FromSnapshot

size
​integer | null · uint64

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)

snapshot_id
​string

Source snapshot from which volume will be created.

scaleway.block.v1.ListSnapshotsRequest.OrderBy

string · enum
Enum values:
created_at_asc
created_at_desc
name_asc
name_desc
Default: created_at_asc

scaleway.block.v1.ListSnapshotsResponse

Paginated returned list of snapshots.

total_count
​integer · uint64

Total number of snapshots in the project.

scaleway.block.v1.ListVolumeTypesResponse

​scaleway.block.v1.VolumeType[]

Returns paginated list of volume-types.

total_count
​integer · uint64

Total number of volume-types currently available in stock.

scaleway.block.v1.ListVolumesRequest.OrderBy

string · enum
Enum values:
created_at_asc
created_at_desc
name_asc
name_desc
Default: created_at_asc

scaleway.block.v1.ListVolumesResponse

Paginated returned list of volumes.

total_count
​integer · uint64

Total number of volumes in the project.

scaleway.block.v1.Reference

id
​string

UUID of the reference. (UUID format)

product_resource_type
​string

Type of resource to which the reference is associated.

product_resource_id
​string

UUID of the product resource it refers to (according to the product_resource_type). (UUID format)

created_at
​string | null · date-time

Creation date of the reference. (RFC 3339 format)

type
​scaleway.block.v1.Reference.Type · enum

Type of reference (link, exclusive, read_only).

Enum values:
unknown_type
link
exclusive
read_only
Default: unknown_type
status
​scaleway.block.v1.Reference.Status · enum

Status of the reference. Statuses include attaching, attached, and detaching.

Enum values:
unknown_status
attaching
attached
detaching
detached
creating
error
Default: unknown_status

scaleway.block.v1.Reference.Status

string · enum
Enum values:
unknown_status
attaching
attached
detaching
detached
creating
error
Default: unknown_status

scaleway.block.v1.Reference.Type

string · enum
Enum values:
unknown_type
link
exclusive
read_only
Default: unknown_type

scaleway.block.v1.Snapshot

id
​string

UUID of the snapshot. (UUID format)

name
​string

Name of the snapshot.

Information about the parent volume. If the parent volume was deleted, value is null.

size
​integer · uint64

Size in bytes of the snapshot. (in bytes)

project_id
​string

UUID of the project the snapshot belongs to. (UUID format)

created_at
​string | null · date-time

Creation date of the snapshot. (RFC 3339 format)

updated_at
​string | null · date-time

Last modification date of the properties of a snapshot. (RFC 3339 format)

List of the references to the snapshot.

status
​scaleway.block.v1.Snapshot.Status · enum

Current status of the snapshot (available, in_use, ...).

Enum values:
unknown_status
creating
available
error
deleting
deleted
in_use
locked
Default: unknown_status
tags
​string[]

List of tags assigned to the volume.

zone
​string

Snapshot zone.

class
​scaleway.block.v1.StorageClass · enum

Storage class of the snapshot.

Enum values:
unknown_storage_class
unspecified
bssd
sbs
Default: unknown_storage_class
public
​boolean

True if the snapshot can be used by anyone to create a volume from.

kms_key_id
​string | null

KMS Key used for securing the parent volume's encryption. (UUID format)

srn
​string

The SRN of the snapshot.

scaleway.block.v1.Snapshot.ParentVolume

id
​string

Parent volume UUID (volume from which the snapshot originates). (UUID format)

name
​string

Name of the parent volume.

type
​string

Volume type of the parent volume.

status
​scaleway.block.v1.Volume.Status · enum

Current status the parent volume.

Enum values:
unknown_status
creating
available
in_use
deleting
deleted
resizing
error
Default: unknown_status

scaleway.block.v1.Snapshot.Status

string · enum
Enum values:
unknown_status
creating
available
error
deleting
deleted
in_use
locked
Default: unknown_status

scaleway.block.v1.StorageClass

string · enum
Enum values:
unknown_storage_class
unspecified
bssd
sbs
Default: unknown_storage_class

scaleway.block.v1.Volume

id
​string

UUID of the volume. (UUID format)

name
​string

Name of the volume.

type
​string

Volume type.

size
​integer · uint64

Volume size in bytes. (in bytes)

project_id
​string

UUID of the project to which the volume belongs. (UUID format)

created_at
​string | null · date-time

Creation date of the volume. (RFC 3339 format)

updated_at
​string | null · date-time

Last update of the properties of a volume. (RFC 3339 format)

List of the references to the volume.

parent_snapshot_id
​string | null

When a volume is created from a snapshot, is the UUID of the snapshot from which the volume has been created. (UUID format)

status
​scaleway.block.v1.Volume.Status · enum

Current status of the volume (available, in_use, ...).

Enum values:
unknown_status
creating
available
in_use
deleting
deleted
resizing
error
Default: unknown_status
tags
​string[]

List of tags assigned to the volume.

zone
​string

Volume zone.

Specifications of the volume.

last_detached_at
​string | null · date-time

Last time the volume was detached. (RFC 3339 format)

kms_key_id
​string | null

KMS Key used for securing the volume's encryption. (UUID format)

srn
​string

The SRN of the volume.

scaleway.block.v1.Volume.Status

string · enum
Enum values:
unknown_status
creating
available
in_use
deleting
deleted
resizing
error
Default: unknown_status

scaleway.block.v1.VolumeSpecifications

perf_iops
​integer | null · uint32

The maximum IO/s expected, according to the different options available in stock (5000 | 15000).

class
​scaleway.block.v1.StorageClass · enum

The storage class of the volume.

Enum values:
unknown_storage_class
unspecified
bssd
sbs
Default: unknown_storage_class

scaleway.block.v1.VolumeType

type
​string

Volume type.

​google.type.Money

Price of the volume billed in GB/hour.

​google.type.Money

Price of the snapshot billed in GB/hour.

Volume specifications of the volume type.

zone
​string

Zone of the volume type.

srn
​string

The SRN of the volume type.