ab58788fc9
Corrects the error status responses for os-baremetal-nodes Part of bp:api-ref-in-rst Change-Id: I2bc63218e6e0ab6cc80cad75351a76e28da094d1
71 lines
1.5 KiB
ReStructuredText
71 lines
1.5 KiB
ReStructuredText
.. -*- rst -*-
|
|
.. needs:parameter_verification
|
|
.. needs:example_verification
|
|
.. needs:body_verification
|
|
|
|
=======================================
|
|
Bare metal nodes (os-baremetal-nodes)
|
|
=======================================
|
|
|
|
Bare metal nodes.
|
|
|
|
|
|
List Bare Metal Nodes
|
|
=====================
|
|
|
|
.. rest_method:: GET /v2.1/{tenant_id}/servers/{server_id}/os-baremetal-nodes
|
|
|
|
Lists the bare metal nodes that are associated with a server.
|
|
|
|
Normal response codes: 202
|
|
|
|
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404), notImplemented(501)
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- tenant_id: tenant_id
|
|
- server_id: server_id
|
|
|
|
Response
|
|
--------
|
|
|
|
**Example List Bare Metal Nodes: JSON response**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/os-baremetal-nodes/baremetal-node-list-resp.json
|
|
:language: javascript
|
|
|
|
Show Bare Metal Node Details
|
|
============================
|
|
|
|
.. rest_method:: GET /v2.1/{tenant_id}/servers/{server_id}/os-baremetal-nodes/{node_id}
|
|
|
|
Shows details for a bare metal node.
|
|
|
|
Preconditions
|
|
|
|
The bare metal node must be associated with the server.
|
|
|
|
Normal response codes: 202
|
|
|
|
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404), notImplemented(501)
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- tenant_id: tenant_id
|
|
- server_id: server_id
|
|
- node_id: node_id
|
|
|
|
Response
|
|
--------
|
|
|
|
**Example Show Bare Metal Node Details: JSON response**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/os-baremetal-nodes/baremetal-node-get-resp.json
|
|
:language: javascript
|