@akamai/openapi-ts
    Preparing search index...

    Type Alias GetVolumeResponses

    type GetVolumeResponses = {
        "200": {
            created: string;
            encryption: "enabled" | "disabled";
            filesystem_path: string;
            hardware_type: "hdd" | "nvme";
            id: number;
            io_ready: boolean;
            label: string;
            linode_id: number | null;
            linode_label: string | null;
            region: string;
            size: number;
            status: "creating" | "active" | "resizing" | "key_rotating";
            tags: string[];
            updated: string;
        };
    }
    Index

    Properties

    200

    Properties

    "200": {
        created: string;
        encryption: "enabled" | "disabled";
        filesystem_path: string;
        hardware_type: "hdd" | "nvme";
        id: number;
        io_ready: boolean;
        label: string;
        linode_id: number | null;
        linode_label: string | null;
        region: string;
        size: number;
        status: "creating" | "active" | "resizing" | "key_rotating";
        tags: string[];
        updated: string;
    }

    Volume

    A Block Storage volume on your account.

    Type Declaration

    • Readonlycreated: string

      Read-only When this volume was created.

    • encryption: "enabled" | "disabled"

      Read-only Whether encryption is enabled on this volume.

    • Readonlyfilesystem_path: string

      Read-only The full file system path for the volume, based on its label. The path is /dev/disk/by-id/scsi-0Linode_Volume_label.

    • hardware_type: "hdd" | "nvme"

      Read-only The storage type of this volume. This can be either hdd to emulate a hard disk drive for the volume, or nvme to emulate a non-volatile memory express solid state drive.

    • Readonlyid: number

      Read-only The unique identifier for the volume.

    • Readonlyio_ready: boolean

      Read-only Indicates whether the volume is successfully attached to a Linode and ready for read and write operations.

    • label: string

      Filterable The name of the volume. A label can be up to 32 characters long and contain alphanumeric characters, hyphens, and underscores. This value is also used in the volume's filesystem_path.

    • linode_id: number | null

      The unique identifier of the Linode this volume is attached to, if applicable.

    • Readonlylinode_label: string | null

      Read-only The name of the Linode this volume is attached to, if applicable.

    • region: string

      The unique identifier for the region where the volume lives.

    • size: number

      The volume's size, in gigabytes.

    • status: "creating" | "active" | "resizing" | "key_rotating"

      Read-only The current status of the volume. This can be one of:

      • creating. The API is creating the volume and it's not ready for use.

      • active. The volume is online and ready for use.

      • resizing. The volume's capacity is being upgraded.

      • key_rotating. The volume's encryption keys are being rotated to new values. Requests to resize, delete, or clone a volume fail during encryption key rotation.

    • tags: string[]

      Filterable Any tags applied to this object. Use tags to label and organize your cloud computing resources.

    • Readonlyupdated: string

      Read-only When this volume was last updated.

    Settings

    Member Visibility

    On This Page

    Properties