Getting StartedAPI ReferenceRecipesGitHub
API Reference

List cluster disks

get
https://cluster.ip.address/v2/clusters/disks

Privileges: CLUSTER_VIEW

List disks on the cluster.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
ids
array of int64s

If non-empty, only disks with these ids are returned.

ids
nodeIds
array of int64s

If non-empty, only disks on these nodes are returned.

nodeIds
boolean

If true, fetch disk read/write I/O statistics.

boolean

If true, fetch disk space usage details (used, free, and usage percentage).

diskStates
array of strings

Optional filters controlling which disks are listed:
kInMigration - include disks that are currently in migration;
kOkToRemove - only disks in kOkToRemove state;
kMarkedForRemoval - include disks marked for removal.
When omitted, the API returns the standard disk list, which excludes
disks marked for removal and does not restrict the results to
migration or kOkToRemove states.

diskStates
Allowed:
Responses

Updated about 5 hours ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 5 hours ago

Did this page help you?