Skip to content

Latest commit

 

History

History
163 lines (117 loc) · 6.55 KB

volume_v1.md

File metadata and controls

163 lines (117 loc) · 6.55 KB
Raw

CSI Proxy Volume v1 API

Table of Contents

v1 Volume RPCs

Method Name Request Type Response Type Description
ListVolumesOnDisk ListVolumesOnDiskRequest ListVolumesOnDiskResponse ListVolumesOnDisk returns the volume IDs (in \.\Volume{GUID} format) for all volumes from a given disk number and partition number (optional)
MountVolume MountVolumeRequest MountVolumeResponse MountVolume mounts the volume at the requested global staging path.
UnmountVolume UnmountVolumeRequest UnmountVolumeResponse UnmountVolume flushes data cache to disk and removes the global staging path.
IsVolumeFormatted IsVolumeFormattedRequest IsVolumeFormattedResponse IsVolumeFormatted checks if a volume is formatted.
FormatVolume FormatVolumeRequest FormatVolumeResponse FormatVolume formats a volume with NTFS.
ResizeVolume ResizeVolumeRequest ResizeVolumeResponse ResizeVolume performs resizing of the partition and file system for a block based volume.
GetVolumeStats GetVolumeStatsRequest GetVolumeStatsResponse GetVolumeStats gathers total bytes and used bytes for a volume.
GetDiskNumberFromVolumeID GetDiskNumberFromVolumeIDRequest GetDiskNumberFromVolumeIDResponse GetDiskNumberFromVolumeID gets the disk number of the disk where the volume is located.
GetVolumeIDFromTargetPath GetVolumeIDFromTargetPathRequest GetVolumeIDFromTargetPathResponse GetVolumeIDFromTargetPath gets the volume id for a given target path.
WriteVolumeCache WriteVolumeCacheRequest WriteVolumeCacheResponse WriteVolumeCache write volume cache to disk.

Top

v1 Volume Messages

FormatVolumeRequest

Field Type Label Description
volume_id string Volume device ID of the volume to format.

FormatVolumeResponse

Intentionally empty.

GetDiskNumberFromVolumeIDRequest

Field Type Label Description
volume_id string Volume device ID of the volume to get the disk number for.

GetDiskNumberFromVolumeIDResponse

Field Type Label Description
disk_number uint32 Corresponding disk number.

GetVolumeIDFromTargetPathRequest

Field Type Label Description
target_path string The target path.

GetVolumeIDFromTargetPathResponse

Field Type Label Description
volume_id string The volume device ID.

GetVolumeStatsRequest

Field Type Label Description
volume_id string Volume device Id of the volume to get the stats for.

GetVolumeStatsResponse

Field Type Label Description
total_bytes int64 Total bytes
used_bytes int64 Used bytes

IsVolumeFormattedRequest

Field Type Label Description
volume_id string Volume device ID of the volume to check.

IsVolumeFormattedResponse

Field Type Label Description
formatted bool Is the volume formatted with NTFS.

ListVolumesOnDiskRequest

Field Type Label Description
disk_number uint32 Disk device number of the disk to query for volumes.
partition_number uint32 The partition number (optional), by default it uses the first partition of the disk.

ListVolumesOnDiskResponse

Field Type Label Description
volume_ids string repeated Volume device IDs of volumes on the specified disk.

MountVolumeRequest

Field Type Label Description
volume_id string Volume device ID of the volume to mount.
target_path string Path in the host's file system where the volume needs to be mounted.

MountVolumeResponse

Intentionally empty.

ResizeVolumeRequest

Field Type Label Description
volume_id string Volume device ID of the volume to resize.
size_bytes int64 New size in bytes of the volume.

ResizeVolumeResponse

Intentionally empty.

UnmountVolumeRequest

Field Type Label Description
volume_id string Volume device ID of the volume to dismount.
target_path string Path where the volume has been mounted.

UnmountVolumeResponse

Intentionally empty.

WriteVolumeCacheRequest

Field Type Label Description
volume_id string Volume device ID of the volume to flush the cache.

WriteVolumeCacheResponse

Intentionally empty.