GET for all file servers
GET {{baseUrl}}/api/v1/storage-systems/device-type6?limit=100&offset=0&filter=<string>&sort=name asc
This API endpoint is to GET all file servers present on the storage system
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
limit | number | Number of items to return at a time | |
offset | number | The offset of the first item in the collection to return | |
filter | string | The filter query parameter is used to filter the set of resources | |
| returned in the response. The returned set of resources must match the | |||
| criteria in the filter query parameter |
A comparison compares a property name to a literal. The comparisons supported are the following:
- “eq” : Is a property equal to value. Valid for number, boolean and string properties.
- “gt” : Is a property greater than a value. Valid for number or string timestamp properties.
- “lt” : Is a property less than a value. Valid for number or string timestamp properties
- “in” : Is a value in a property (that is an array of strings)
Filters are supported on the following properties:
- id
- uuid
- generation
- name
Examples:
- GET /api/v1/storage-systems/device-type6?filter=uuid eq 1ab3fd09-5d0b-32b1-b86f-22e88dacd13d
|
|
sort| string | | A list of properties defining the sort order. This takes a single property name followed by the direction to sort in, separated by a space.
If not specified, the default behaviour is to sort by name. The supported directions are
asc and desc for ascending and descending respectively.
Sorting is supported on the following properties:
- id
- uuid
- generation
- name |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"items":[{"clusterIP":"\u003cipv4\u003e","connectionStatus":null,"customerId":"\u003cstring\u003e","dataReductionRatio":"\u003cstring\u003e","enclosures":[{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","resourceUri":"\u003cstring\u003e","type":"\u003cstring\u003e"},{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","resourceUri":"\u003cstring\u003e","type":"\u003cstring\u003e"}],"freeCapacityInGiB":"\u003cfloat\u003e","generation":"\u003clong\u003e","healthStatus":"OFFLINE","id":"\u003clong\u003e","jbofEnclosures":[{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","resourceUri":"\u003cstring\u003e","type":"\u003cstring\u003e"},{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","resourceUri":"\u003cstring\u003e","type":"\u003cstring\u003e"}],"logicalCapacityInUse":"\u003clong\u003e","memoryRaidRebuildProgress":"\u003cinteger\u003e","memoryRaidState":"\u003cstring\u003e","modelNum":"\u003cstring\u003e","name":"\u003cstring\u003e","nvramRaidRebuildProgress":"\u003cinteger\u003e","nvramRaidState":"\u003cstring\u003e","nvramSize":"\u003clong\u003e","physicalCapacityInUse":"\u003clong\u003e","resourceUri":"\u003cstring\u003e","savingsInGiB":"\u003cfloat\u003e","savingsPct":"\u003cfloat\u003e","serialNumber":"\u003cstring\u003e","snapUsageInGiB":"\u003cfloat\u003e","ssdRaidRebuildProgress":"\u003cinteger\u003e","ssdRaidState":"\u003cstring\u003e","swVersion":"\u003cstring\u003e","switches":[{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","resourceUri":"\u003cstring\u003e","type":"\u003cstring\u003e"},{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","resourceUri":"\u003cstring\u003e","type":"\u003cstring\u003e"}],"totalCapacityInGiB":"\u003cfloat\u003e","type":"\u003cstring\u003e","upTime":"\u003clong\u003e","usedCapacityInGiB":"\u003cfloat\u003e","usedCapacityPercentage":"\u003cfloat\u003e","uuid":"\u003cuuid\u003e"},{"clusterIP":"\u003cipv4\u003e","connectionStatus":null,"customerId":"\u003cstring\u003e","dataReductionRatio":"\u003cstring\u003e","enclosures":[{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","resourceUri":"\u003cstring\u003e","type":"\u003cstring\u003e"},{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","resourceUri":"\u003cstring\u003e","type":"\u003cstring\u003e"}],"freeCapacityInGiB":"\u003cfloat\u003e","generation":"\u003clong\u003e","healthStatus":"DEACTIVATING","id":"\u003clong\u003e","jbofEnclosures":[{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","resourceUri":"\u003cstring\u003e","type":"\u003cstring\u003e"},{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","resourceUri":"\u003cstring\u003e","type":"\u003cstring\u003e"}],"logicalCapacityInUse":"\u003clong\u003e","memoryRaidRebuildProgress":"\u003cinteger\u003e","memoryRaidState":"\u003cstring\u003e","modelNum":"\u003cstring\u003e","name":"\u003cstring\u003e","nvramRaidRebuildProgress":"\u003cinteger\u003e","nvramRaidState":"\u003cstring\u003e","nvramSize":"\u003clong\u003e","physicalCapacityInUse":"\u003clong\u003e","resourceUri":"\u003cstring\u003e","savingsInGiB":"\u003cfloat\u003e","savingsPct":"\u003cfloat\u003e","serialNumber":"\u003cstring\u003e","snapUsageInGiB":"\u003cfloat\u003e","ssdRaidRebuildProgress":"\u003cinteger\u003e","ssdRaidState":"\u003cstring\u003e","swVersion":"\u003cstring\u003e","switches":[{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","resourceUri":"\u003cstring\u003e","type":"\u003cstring\u003e"},{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","resourceUri":"\u003cstring\u003e","type":"\u003cstring\u003e"}],"totalCapacityInGiB":"\u003cfloat\u003e","type":"\u003cstring\u003e","upTime":"\u003clong\u003e","usedCapacityInGiB":"\u003cfloat\u003e","usedCapacityPercentage":"\u003cfloat\u003e","uuid":"\u003cuuid\u003e"}],"pageLimit":"\u003cinteger\u003e","pageOffset":"\u003cinteger\u003e","total":"\u003cinteger\u003e"}