Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14126767600.8 KB

Gets a persistent volume.

get/2023-10-12/farms/{farmId}/fleets/{fleetId}/volumes/{volumeId}

Path parameters

farmIdstring required

The farm ID of the farm that contains the fleet.

fleetIdstring required

The fleet ID of the fleet that contains the volume.

volumeIdstring required

The volume ID of the volume to retrieve.

Response

Success

volumeIdstring required

The volume ID.

farmIdstring required

The farm ID of the farm that contains the fleet.

fleetIdstring required

The fleet ID of the fleet that contains the volume.

state'PENDING_CREATION' | 'PENDING_ATTACHMENT' | 'IN_USE' | 'AVAILABLE' | 'PENDING_DELETION' required

The state of the volume.

sizeGiBinteger required

The volume size in GiB.

availabilityZoneIdstring required

The Availability Zone ID of the volume.

attachedWorkerIdstring

The worker ID of the worker the volume is attached to.

volumeType'gp3' required

The EBS volume type.

iopsinteger

The IOPS of the volume.

throughputMiBinteger

The throughput of the volume in MiB.

createdAtstring date-time required

The date and time the resource was created.

lastAssignedAtstring date-time

The date and time the volume was last assigned to a worker.

lastReleasedAtstring date-time

The date and time the volume was last released from a worker.

expiresAtstring date-time

The date and time the volume expires and will be deleted.