Files
cyborg/api-ref/source/devices.inc
zhangbailin b15a7a7120 Remove the redundant index page for APIs entry
Now we just have using V2 API, and we have no plans to add other versions
of the API, the current API page entry is redundant [1], this patch will
remove it.

[1] https://docs.openstack.org/api-ref/accelerator/

Change-Id: Idd6aa49b3d63b4acbda2444d892e28158b011ad5
2021-08-14 18:25:16 +08:00

48 lines
1.0 KiB
ReStructuredText

.. -*- rst -*-
.. needs:body_verification
Devices
+++++++
Lists, shows details for devices.
A `device` represent a physical card like FPGA card or GPU card.
List Devices
------------
.. rest_method:: GET /v2/devices
Lists UUIDs, names, type and more informations for all devices.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403)
**Example response: list all devices**
.. literalinclude:: ../../doc/api_samples/devices/devices-list-resp.json
:language: javascript
Get One Device
--------------
.. rest_method:: GET /v2/devices/{device_uuid}
Gets the UUID, name, type and more informations for one device with the specified UUID.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403)
Request
=======
.. rest_parameters:: parameters.yaml
- device_uuid: device_uuid
**Example response: show details of a specific device**
.. literalinclude:: ../../doc/api_samples/devices/devices-getone-resp.json
:language: javascript