Devices

List Devices

Lists all devices, optionally filtered by node, failed status, missing status, device label, serial number, or uuid. Devices may also be filtered by &cluster=<cluster_id> or &failed=true.

GET /api/v1/devices/
Query Parameters:
 
  • id -- Filter responses by device id
  • node -- Filter responses by node id
  • size -- Filter responses by device size
  • serial -- Filter responses by serial number
  • label -- Filter responses by device label
  • missing -- Filter responses by missing status
  • uuid -- Filter responses by exact UUID
Status:

200 OK
Status:

400 Bad Request
Status:

404 Not Found

Example request:

Example response:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
{
    "meta": {
        "limit": 20,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": 1
    },
    "objects": [
        {
            "blinking": null,
            "cluster": "/api/v1/clusters/1/",
            "desired_mount_point": "/srv/node/d2",
            "failed": true,
            "gb": 12884.901888,
            "id": 4,
            "kernel_dev": "sdd",
            "label": "d2",
            "missing": false,
            "mounted": true,
            "node": "/api/v1/nodes/1/",
            "node_hostname": "swift-node1",
            "resource_uri": "/api/v1/devices/4/",
            "rotational": true,
            "serial": "",
            "uuid": "59ef58f9-9f03-4273-9e25-ffe0f36d7e1a"
        }
    ]
}

View Device Details

Display information about a device.

GET /api/v1/devices/<device_id>/
Status:200 OK
Status:400 Bad Request
Status:404 Not Found

Example request:

curl -1 https://scswiftcontroller.tatamediaservices.com/api/v1/devices/<device_id>/ -H 'Authorization: apikey <user>:<api_key>'

Example response:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
{
    "blinking": null,
    "cluster": "/api/v1/clusters/1/",
    "desired_mount_point": "/srv/node/d0",
    "failed": false,
    "gb": 12725.601888,
    "id": 2,
    "kernel_dev": "sdb",
    "label": "d0",
    "missing": false,
    "mounted": true,
    "node": "/api/v1/nodes/10/",
    "node_hostname": "swift-node3",
    "resource_uri": "/api/v1/devices/2/",
    "rotational": true,
    "serial": "",
    "uuid": "b9395492-7c83-4f72-9a28-f890792c62fb"
}