GET /api/v1/data/devices/{id}/fans
Use this method to return fan information for a specific device.
Authentication
Authentication with username and password is required.
Resource URI
GET https://{orchestrator_server_IP}/api/v1/data/devices/{id}/fans
where {id} is the ID of the device. To obtain the device IDs, use GET /api/v1/data/devices.
Query parameters
None
Request body
None
Response codes
| Code | Description | Comments |
|---|---|---|
| 200 | OK | The request completed successfully. |
| 404 | Not found | The resource cannot be found. A descriptive error message is returned in the response body. |
Response body
When the request is successful, the following attributes are returned. If the request fails, standard message attributes are returned (see Status messages).
| Attributes | Type | Description | ||
|---|---|---|---|---|
| fans | Array of objects | Information about each fan in the device | ||
| description | String | Fan description | ||
| healthState | String | Fan health state (translated). This can be one of the following values.
| ||
| healthStateKey | String | Fan health state key. This can be one of the following values.
| ||
| name | String | Fan name | ||
| slots | Integer | Fan slot | ||
| speed | Integer | Fan speed | ||
| status | String | Fan status | ||
| _links | Object | Device URI (see Links) | ||
The following example is returned if the request is successful.
{
"fans": [{
"description": "Logical Device for fan / cooling device 1",
"healthState": "Normal",
"healthStateKey": "Normal",
"name": "Fan 1",
"slots": 1,
"speed": 0,
"status": "OK"
},
...,
{
"description": "Logical Device for fan / cooling device 7",
"healthState": "Normal",
"healthStateKey": "Normal",
"name": "Fan 7",
"slots": 7,
"speed": 0,
"status": "OK"
}],
"_links": {
"rel": "self",
"uri": "/api/v1/data/devices/C7199530FEDE4FE09540DFC3D75FC56C/fans"
}
}
Give documentation feedback