The following table describes all search options for volumes.
| Property (of resource or resource-type) | Type | Description (Reference) |
|---|---|---|
| Clusters.clusters prop | See property types in Section C.2.1, “Searching for Clusters” | The property of the clusters associated with the volume. |
| name | String | The name of the volume. |
| status | List | The availability of the volume. |
| type | List | The type of the volume. |
| transport_type | List | The transport type of the volume. |
| replica_count | Integer | The replicate count of the volume. |
| stripe_count | Integer | The stripe count of the volume. |
| sortby | List | Sorts the returned results by one of the resource properties |
| page | Integer | The page number of results to display |
Example
Volumes: Cluster.name = Default and Status = Up
Returns a list of Volumes, where:
- Belongs to a Default Cluster and the status of the volume is Up.