hetzner/volume_actions

Types

VolumeActionSortOption = enum
  sortId = "id", sortIdAsc = "id:asc", sortIdDesc = "id:desc",
  sortCommand = "command", sortCommandAsc = "command:asc",
  sortCommandDesc = "command:desc", sortStatus = "status",
  sortStatusAsc = "status:asc", sortStatusDesc = "status:desc",
  sortProgress = "progress", sortProgressAsc = "progress:asc",
  sortProgressDesc = "progress:desc", sortStarted = "started",
  sortStartedAsc = "started:asc", sortStartedDesc = "started:desc",
  sortFinished = "finished", sortFinishedAsc = "finished:asc",
  sortFinishedDesc = "finished:desc"
VolumeActionStatusOption = enum
  statusRunning = "running", statusSuccess = "success", statusError = "error"

Procs

proc getVolumesIdActions(client: HetznerClient; id: int64;
                         sort: set[VolumeActionSortOption] = {};
                         status: set[VolumeActionStatusOption] = {}): Future[
    GetVolumesIdActionsResponse] {....stackTrace: false, raises: [Exception,
    ValueError, KeyError, HttpRequestError, LibraryError, SslError, OSError,
    IOError, ProtocolError, OpenParserJsonError, HetznerClientError], tags: [
    RootEffect, ReadIOEffect, TimeEffect], forbids: [].}
Returns all Action objects for a Volume. You can sort the results by using the sort URI parameter, and filter them with the status parameter.
proc getVolumesIdActionsActionId(client: HetznerClient; id: int64;
                                 actionId: int64): Future[
    GetVolumesIdActionsActionIdResponse] {....stackTrace: false, raises: [
    Exception, ValueError, HttpRequestError, LibraryError, SslError, OSError,
    IOError, ProtocolError, KeyError, OpenParserJsonError, HetznerClientError],
    tags: [RootEffect, ReadIOEffect, TimeEffect], forbids: [].}
Returns a specific Action for a Volume.
proc postVolumesIdActionsAttach(client: HetznerClient; id: int64;
                                body: PostVolumesIdActionsAttachRequest): Future[
    PostVolumesIdActionsAttachResponse] {....stackTrace: false, raises: [Exception,
    ValueError, HttpRequestError, LibraryError, SslError, OSError, IOError,
    ProtocolError, KeyError, OpenParserJsonError, HetznerClientError],
    tags: [RootEffect, ReadIOEffect, TimeEffect], forbids: [].}
Attaches a Volume to a Server. Works only if the Server is in the same Location as the Volume.
proc postVolumesIdActionsChangeProtection(client: HetznerClient; id: int64;
    body: PostVolumesIdActionsChangeProtectionRequest): Future[
    PostVolumesIdActionsChangeProtectionResponse] {....stackTrace: false, raises: [
    Exception, ValueError, HttpRequestError, LibraryError, SslError, OSError,
    IOError, ProtocolError, KeyError, OpenParserJsonError, HetznerClientError],
    tags: [RootEffect, ReadIOEffect, TimeEffect], forbids: [].}
Changes the protection configuration of a Volume.
proc postVolumesIdActionsDetach(client: HetznerClient; id: int64): Future[
    PostVolumesIdActionsDetachResponse] {....stackTrace: false, raises: [Exception,
    ValueError, HttpRequestError, LibraryError, SslError, OSError, IOError,
    ProtocolError, KeyError, OpenParserJsonError, HetznerClientError],
    tags: [RootEffect, ReadIOEffect, TimeEffect], forbids: [].}
Detaches a Volume from the Server it’s attached to. You may attach it to a Server again at a later time.
proc postVolumesIdActionsResize(client: HetznerClient; id: int64;
                                body: PostVolumesIdActionsResizeRequest): Future[
    PostVolumesIdActionsResizeResponse] {....stackTrace: false, raises: [Exception,
    ValueError, HttpRequestError, LibraryError, SslError, OSError, IOError,
    ProtocolError, KeyError, OpenParserJsonError, HetznerClientError],
    tags: [RootEffect, ReadIOEffect, TimeEffect], forbids: [].}
Changes the size of a Volume. Note that downsizing a Volume is not possible.