Class API

constructor

• new API(client): Block.v1alpha1.API

• Parameters

  • client: Client

  Returns Block.v1alpha1.API

Static ReadonlyLOCALITIES

createSnapshot

• createSnapshot(request): Promise<Block.v1alpha1.Snapshot>

• Create a snapshot of a volume. To create a snapshot, the volume must be in the in_use or the available status. If your volume is in a transient state, you need to wait until the end of the current operation.

  Parameters

  • request: Readonly<Block.v1alpha1.CreateSnapshotRequest>

    The request CreateSnapshotRequest

  Returns Promise<Block.v1alpha1.Snapshot>

  A Promise of Snapshot

createVolume

• createVolume(request?): Promise<Block.v1alpha1.Volume>

• Create a volume. To create a new volume from scratch, you must specify from_empty and the size. To create a volume from an existing snapshot, specify from_snapshot and the snapshot_id in the request payload instead, size is optional and can be specified if you need to extend the original size. The volume will take on the same volume class and underlying IOPS limitations as the original snapshot.

  Parameters

  • request: Readonly<Block.v1alpha1.CreateVolumeRequest> = {}

    The request CreateVolumeRequest

  Returns Promise<Block.v1alpha1.Volume>

  A Promise of Volume

deleteSnapshot

• deleteSnapshot(request): Promise<void>

• Delete a snapshot. You must specify the snapshot_id of the snapshot you want to delete. The snapshot must not be in use.

  Parameters

  • request: Readonly<Block.v1alpha1.DeleteSnapshotRequest>

    The request DeleteSnapshotRequest

  Returns Promise<void>

deleteVolume

• deleteVolume(request): Promise<void>

• Delete a detached volume. You must specify the volume_id of the volume you want to delete. The volume must not be in the in_use status.

  Parameters

  • request: Readonly<Block.v1alpha1.DeleteVolumeRequest>

    The request DeleteVolumeRequest

  Returns Promise<void>

exportSnapshotToObjectStorage

• exportSnapshotToObjectStorage(request): Promise<Block.v1alpha1.Snapshot>

• Export a snapshot to a Scaleway Object Storage bucket. The snapshot is exported in QCOW2 format. The snapshot must not be in transient state.

  Parameters

  • request: Readonly<ExportSnapshotToObjectStorageRequest>

    The request ExportSnapshotToObjectStorageRequest

  Returns Promise<Block.v1alpha1.Snapshot>

  A Promise of Snapshot

getSnapshot

• getSnapshot(request): Promise<Block.v1alpha1.Snapshot>

• Get a snapshot. Retrieve technical information about a specific snapshot. Details such as size, volume type, and status are returned in the response.

  Parameters

  • request: Readonly<Block.v1alpha1.GetSnapshotRequest>

    The request GetSnapshotRequest

  Returns Promise<Block.v1alpha1.Snapshot>

  A Promise of Snapshot

getVolume

• getVolume(request): Promise<Block.v1alpha1.Volume>

• Get a volume. Retrieve technical information about a specific volume. Details such as size, type, and status are returned in the response.

  Parameters

  • request: Readonly<Block.v1alpha1.GetVolumeRequest>

    The request GetVolumeRequest

  Returns Promise<Block.v1alpha1.Volume>

  A Promise of Volume

importSnapshotFromObjectStorage

• importSnapshotFromObjectStorage(request): Promise<Block.v1alpha1.Snapshot>

• Import a snapshot from a Scaleway Object Storage bucket. The bucket must contain a QCOW2 image. The bucket can be imported into any Availability Zone as long as it is in the same region as the bucket.

  Parameters

  • request: Readonly<Block.v1alpha1.ImportSnapshotFromObjectStorageRequest>

    The request ImportSnapshotFromObjectStorageRequest

  Returns Promise<Block.v1alpha1.Snapshot>

  A Promise of Snapshot

importSnapshotFromS3

• importSnapshotFromS3(request): Promise<Block.v1alpha1.Snapshot>

• (Deprecated in favor of ImportSnapshotFromObjectStorage). Import a snapshot from a Scaleway Object Storage bucket The bucket must contain a QCOW2 image. The bucket can be imported into any Availability Zone as long as it is in the same region as the bucket.

  Parameters

  • request: Readonly<Block.v1alpha1.ImportSnapshotFromS3Request>

    The request ImportSnapshotFromS3Request

  Returns Promise<Block.v1alpha1.Snapshot>

  A Promise of Snapshot

  Deprecated

listSnapshots

• listSnapshots(request?): Promise<Block.v1alpha1.ListSnapshotsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Block.v1alpha1.Snapshot[], void, void>);
      all: (() => Promise<Block.v1alpha1.Snapshot[]>);
  }

• List all snapshots. List all available snapshots in a specified zone. By default, the snapshots listed are ordered by creation date in ascending order. This can be modified via the order_by field.

  Parameters

  • request: Readonly<Block.v1alpha1.ListSnapshotsRequest> = {}

    The request ListSnapshotsRequest

  Returns Promise<Block.v1alpha1.ListSnapshotsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Block.v1alpha1.Snapshot[], void, void>);
      all: (() => Promise<Block.v1alpha1.Snapshot[]>);
  }

  A Promise of ListSnapshotsResponse

listVolumeTypes

• listVolumeTypes(request?): Promise<ListVolumeTypesResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Block.v1alpha1.VolumeType[], void, void>);
      all: (() => Promise<Block.v1alpha1.VolumeType[]>);
  }

• List volume types. List all available volume types in a specified zone. The volume types listed are ordered by name in ascending order.

  Parameters

  • request: Readonly<Block.v1alpha1.ListVolumeTypesRequest> = {}

    The request ListVolumeTypesRequest

  Returns Promise<ListVolumeTypesResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Block.v1alpha1.VolumeType[], void, void>);
      all: (() => Promise<Block.v1alpha1.VolumeType[]>);
  }

  A Promise of ListVolumeTypesResponse

listVolumes

• listVolumes(request?): Promise<Block.v1alpha1.ListVolumesResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Block.v1alpha1.Volume[], void, void>);
      all: (() => Promise<Block.v1alpha1.Volume[]>);
  }

• List volumes. List all existing volumes in a specified zone. By default, the volumes listed are ordered by creation date in ascending order. This can be modified via the order_by field.

  Parameters

  • request: Readonly<Block.v1alpha1.ListVolumesRequest> = {}

    The request ListVolumesRequest

  Returns Promise<Block.v1alpha1.ListVolumesResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Block.v1alpha1.Volume[], void, void>);
      all: (() => Promise<Block.v1alpha1.Volume[]>);
  }

  A Promise of ListVolumesResponse

updateSnapshot

• updateSnapshot(request): Promise<Block.v1alpha1.Snapshot>

• Update a snapshot. Update the name or tags of the snapshot.

  Parameters

  • request: Readonly<Block.v1alpha1.UpdateSnapshotRequest>

    The request UpdateSnapshotRequest

  Returns Promise<Block.v1alpha1.Snapshot>

  A Promise of Snapshot

updateVolume

• updateVolume(request): Promise<Block.v1alpha1.Volume>

• Update a volume. Update the technical details of a volume, such as its name, tags, or its new size and volume_type (within the same Block Storage class). You can only resize a volume to a larger size. It is currently not possible to change your Block Storage Class.

  Parameters

  • request: Readonly<Block.v1alpha1.UpdateVolumeRequest>

    The request UpdateVolumeRequest

  Returns Promise<Block.v1alpha1.Volume>

  A Promise of Volume

waitForSnapshot

• waitForSnapshot(request, options?): Promise<Block.v1alpha1.Snapshot>

• Waits for Snapshot to be in a final state.

  Parameters

  • request: Readonly<Block.v1alpha1.GetSnapshotRequest>

    The request GetSnapshotRequest
  • Optionaloptions: Readonly<WaitForOptions<Block.v1alpha1.Snapshot>>

    The waiting options

  Returns Promise<Block.v1alpha1.Snapshot>

  A Promise of Snapshot

waitForVolume

• waitForVolume(request, options?): Promise<Block.v1alpha1.Volume>

• Waits for Volume to be in a final state.

  Parameters

  • request: Readonly<Block.v1alpha1.GetVolumeRequest>

    The request GetVolumeRequest
  • Optionaloptions: Readonly<WaitForOptions<Block.v1alpha1.Volume>>

    The waiting options

  Returns Promise<Block.v1alpha1.Volume>

  A Promise of Volume