Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.
No Additional PropertiesExtra options are defined on a per-endpoint basis and are described in the documentation for the associated query method.
An array of field names describing the manner in which query results should be ordered. The field names may also have one of more of the following special prefixes: - (reverse sort direction), nulls_first: (place any null values at the head of the results list), nulls_last: (place any null values at the tail of the results list).
[
"size",
"-devname",
"nulls_first:-expiretime"
]
An array of field names specifying the exact fields to include in the query return. The dot character . may be used to explicitly select only subkeys of the query result.
[
"username",
"Authentication.status"
]
Return a numeric value representing the number of items that match the specified query-filters.
Return the JSON object of the first result matching the specified query-filters. The query fails if there specified query-filters return no results.
This specifies the beginning offset of the results array. When combined with the limit query-option it may be used to implement pagination of large results arrays. WARNING: some query methods provide volatile results and the onus is on the developer to understand whether pagination is appropriate for a particular query API method.
This specifies the maximum number of results matching the specified query-filters to return. When combined wtih the offset query-option it may be used to implement pagination of large results arrays.
WARNING: Some query methods provide volatile results and the onus is on the developer to understand whether pagination is appropriate for a particular query API method.
Force use of SQL for result filtering to reduce response time. May not work for all methods.
Unique identifier for this storage pool.
Name of the storage pool.
Globally unique identifier (GUID) for this pool.
Current status of the pool.
"ONLINE"
"DEGRADED"
"FAULTED"
Filesystem path where the pool is mounted.
Information about any active scrub or resilver operation. null if no operation is running.
{
"bytes_issued": null,
"bytes_processed": null,
"bytes_to_process": null,
"end_time": null,
"errors": null,
"function": null,
"pause": null,
"percentage": null,
"start_time": null,
"state": null,
"total_secs_left": null
}
Information about any active pool expansion operation. null if no expansion is running.
{
"bytes_reflowed": 978944,
"bytes_to_reflow": 835584,
"end_time": null,
"expanding_vdev": 0,
"percentage": 85.35564853556485,
"start_time": null,
"state": "FINISHED",
"total_secs_left": null,
"waiting_for_resilver": 0
}
Whether this pool has been upgraded to the latest feature flags.
Whether the pool is in a healthy state with no errors or warnings.
Whether the pool has warning conditions that require attention.
Detailed status code for the pool condition. null if not applicable.
Human-readable description of the pool status. null if not available.
Total size of the pool in bytes. null if not available.
Amount of space currently allocated in the pool in bytes. null if not available.
Amount of free space available in the pool in bytes. null if not available.
Amount of space being freed (in bytes) by ongoing operations. null if not available.
Size of the deduplication table in bytes. null if deduplication is not enabled.
Quota limit for the deduplication table. null if no quota is set.
Percentage of pool fragmentation as a string. null if not available.
Human-readable string representation of the pool size. null if not available.
Human-readable string representation of allocated space. null if not available.
Human-readable string representation of free space. null if not available.
Human-readable string representation of space being freed. null if not available.
Auto-trim configuration for the pool indicating whether automatic TRIM operations are enabled.
{
"parsed": "off",
"rawvalue": "off",
"source": "DEFAULT",
"value": "off"
}
Physical topology and structure of the pool including vdevs. null if not available.
Array of data vdev configurations in the pool.
No Additional ItemsArray of ZFS Intent Log (ZIL) vdev configurations.
No Additional ItemsArray of L2ARC cache vdev configurations.
No Additional ItemsArray of spare disk configurations.
No Additional ItemsArray of special vdev configurations for metadata.
No Additional ItemsArray of deduplication table vdev configurations.
No Additional Items