Scaleway logo
Instance Volume API
Instance Volume API

Schemas

Download schema

scaleway.instance.v2alpha1.CreateVolumeRequest.VolumeType

string · enum
Enum values:
unknown_volume_type
l_ssd
scratch
Default: unknown_volume_type

scaleway.instance.v2alpha1.ListSnapshotsRequest.OrderBy

string · enum
Enum values:
created_at_desc
created_at_asc
updated_at_desc
updated_at_asc
Default: created_at_desc

scaleway.instance.v2alpha1.ListSnapshotsResponse

List of snapshots.

next_page_token
​string | null

Token for the next page.

total_count
​integer · uint64

Total number of items.

scaleway.instance.v2alpha1.ListVolumeTypesResponse

List of volume types.

next_page_token
​string | null

Token for the next page.

total_count
​integer · uint64

Total number of items.

scaleway.instance.v2alpha1.ListVolumesRequest.OrderBy

string · enum
Enum values:
created_at_desc
created_at_asc
updated_at_desc
updated_at_asc
Default: created_at_desc

scaleway.instance.v2alpha1.ListVolumesResponse

List of volumes.

next_page_token
​string | null

Token for the next page.

total_count
​integer · uint64

Total number of items.

scaleway.instance.v2alpha1.Snapshot

id
​string

Unique ID of the snapshot.

srn
​string

The SRN of the snapshot.

project_id
​string

Project ID of the snapshot.

name
​string

Name of the snapshot.

tags
​string[]

Tags associated with the snapshot.

size
​integer · uint64

Size of the snapshot in bytes. (in bytes)

status
​scaleway.instance.v2alpha1.Snapshot.Status · enum

Current status of the snapshot.

Enum values:
unknown_status
available
creating
error
invalid_data
exporting
Default: unknown_status
base_volume_id
​string | null

ID of the base volume.

volume_type
​scaleway.instance.v2alpha1.Snapshot.VolumeType · enum

Type of the volume.

Enum values:
unknown_volume_type
l_ssd
Default: unknown_volume_type
created_at
​string | null · date-time

Creation date of the snapshot. (RFC 3339 format)

updated_at
​string | null · date-time

Last update date of the snapshot. (RFC 3339 format)

zone
​string

Zone in which the snapshot is located.

public
​boolean

Whether the snapshot is public.

scaleway.instance.v2alpha1.Snapshot.Status

string · enum
Enum values:
unknown_status
available
creating
error
invalid_data
exporting
Default: unknown_status

scaleway.instance.v2alpha1.Snapshot.VolumeType

string · enum
Enum values:
unknown_volume_type
l_ssd
Default: unknown_volume_type

scaleway.instance.v2alpha1.Volume

id
​string

Unique ID of the volume.

srn
​string

The SRN of the volume.

project_id
​string

Project ID to which the volume belongs.

name
​string

Volume name.

tags
​string[]

Tags associated with the volume.

size
​integer · uint64

Volume size in bytes. (in bytes)

base_snapshot_id
​string | null

ID of the base snapshot used for this volume.

status
​scaleway.instance.v2alpha1.Volume.Status · enum

Current status of the volume.

Enum values:
unknown_status
available
snapshotting
attaching
detaching
creating
migrating
error
Default: unknown_status
volume_type
​scaleway.instance.v2alpha1.Volume.VolumeType · enum

Type of the volume.

Enum values:
unknown_volume_type
l_ssd
scratch
Default: unknown_volume_type
created_at
​string | null · date-time

Creation date of the volume. (RFC 3339 format)

updated_at
​string | null · date-time

Last update date of the volume. (RFC 3339 format)

server_id
​string | null

ID of the Instance to which the volume is attached.

zone
​string

Zone in which the volume is located.

scaleway.instance.v2alpha1.Volume.Status

string · enum
Enum values:
unknown_status
available
snapshotting
attaching
detaching
creating
migrating
error
Default: unknown_status

scaleway.instance.v2alpha1.Volume.VolumeType

string · enum
Enum values:
unknown_volume_type
l_ssd
scratch
Default: unknown_volume_type

scaleway.instance.v2alpha1.VolumeType

Name of the volume type.

Enum values:
unknown_volume_type
l_ssd
scratch
Default: unknown_volume_type
min_size
​integer · uint64

Minimum size of the volume in bytes.

max_size
​integer · uint64

Maximum size of the volume in bytes.