Skip to content
Docs

    Volumes

    Create Volume
    $ nirvana compute:volumes create
    POST/v1/compute/volumes
    Get Volume
    $ nirvana compute:volumes get
    GET/v1/compute/volumes/{volume_id}
    Update Volume
    $ nirvana compute:volumes update
    PATCH/v1/compute/volumes/{volume_id}
    Delete Volume
    $ nirvana compute:volumes delete
    DELETE/v1/compute/volumes/{volume_id}
    List Volumes
    $ nirvana compute:volumes list
    GET/v1/compute/volumes
    Attach Volume
    $ nirvana compute:volumes attach
    POST/v1/compute/volumes/{volume_id}/attach
    Detach Volume
    $ nirvana compute:volumes detach
    POST/v1/compute/volumes/{volume_id}/detach
    ModelsExpand Collapse
    volume: object { id, created_at, kind, 10 more }

    Volume details.

    id: string

    Unique identifier for the Volume.

    created_at: string

    When the Volume was created.

    kind: "boot" or "data"

    Volume kind.

    "boot"
    "data"
    name: string

    Name of the Volume.

    project_id: string

    Project ID the Volume belongs to.

    region: "us-sva-2"

    Region the resource is in.

    "us-sva-2"
    size: number

    Size of the Volume in GB.

    status: "pending" or "creating" or "updating" or 4 more

    Status of the resource.

    "pending"
    "creating"
    "updating"
    "ready"
    "deleting"
    "deleted"
    "error"
    tags: array of string

    Tags to attach to the Volume.

    type: "nvme" or "abs"

    Type of the Volume.

    "nvme"
    "abs"
    updated_at: string

    When the Volume was updated.

    vm_id: string

    ID of the VM the Volume is attached to.

    vm_name: string

    Name of the VM the Volume is attached to.

    volume_kind: "boot" or "data"

    Volume kind.

    "boot"
    "data"
    volume_list: object { items, pagination }
    items: array of Volume { id, created_at, kind, 10 more }
    id: string

    Unique identifier for the Volume.

    created_at: string

    When the Volume was created.

    kind: "boot" or "data"

    Volume kind.

    "boot"
    "data"
    name: string

    Name of the Volume.

    project_id: string

    Project ID the Volume belongs to.

    region: "us-sva-2"

    Region the resource is in.

    "us-sva-2"
    size: number

    Size of the Volume in GB.

    status: "pending" or "creating" or "updating" or 4 more

    Status of the resource.

    "pending"
    "creating"
    "updating"
    "ready"
    "deleting"
    "deleted"
    "error"
    tags: array of string

    Tags to attach to the Volume.

    type: "nvme" or "abs"

    Type of the Volume.

    "nvme"
    "abs"
    updated_at: string

    When the Volume was updated.

    vm_id: string

    ID of the VM the Volume is attached to.

    vm_name: string

    Name of the VM the Volume is attached to.

    volume_type: "nvme" or "abs"

    Type of the Volume.

    "nvme"
    "abs"

    VolumesAvailability

    Check Volume Create Availability
    $ nirvana compute:volumes:availability create
    POST/v1/compute/volumes/availability
    Check Volume Update Availability
    $ nirvana compute:volumes:availability update
    PATCH/v1/compute/volumes/{volume_id}/availability

    VolumesCost

    Estimate Volume Create Cost
    $ nirvana compute:volumes:cost create
    POST/v1/compute/volumes/cost
    Estimate Volume Update Cost
    $ nirvana compute:volumes:cost update
    PATCH/v1/compute/volumes/{volume_id}/cost