nova/api-ref/source/os-interface.inc
jichenjc 0e5000887b Complete Method Verification of os-interface
verified the API doc for os-interface, changes sequence of
POST/GET and remove some common error code like 500, 503 etc

Part of bp:api-ref-in-rst

Change-Id: I9d825e278a3f02e397b6258f193e3236f9f499da
2016-04-23 22:54:22 +08:00

149 lines
3.3 KiB
ReStructuredText

.. -*- rst -*-
.. needs:parameter_verification
.. needs:example_verification
.. needs:body_verification
=========================================
Port interfaces (servers, os-interface)
=========================================
Creates a port interface and uses it to attach a port to a server and
detaches a port interface from a server. Also, lists all port interfaces
and shows details for a port interface.
List Port Interfaces
====================
.. rest_method:: GET /v2.1/{tenant_id}/servers/{server_id}/os-interface
Lists port interfaces that are attached to a server.
Normal response codes: 200
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
--------
.. rest_parameters:: parameters.yaml
- interfaceAttachment: interfaceAttachment
- port_state: port_state
- fixed_ips: fixed_ips
- mac_addr: mac_addr
- net_id: net_id
- port_id: port_id
**Example List Port Interfaces: JSON response**
.. literalinclude:: ../../doc/api_samples/os-attach-interfaces/attach-interfaces-list-resp.json
:language: javascript
Create Interface
================
.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/os-interface
Creates a port interface and uses it to attach a port to a server instance.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404), conflict(409), computeFault(500), NotImplemented(501)
Request
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- server_id: server_id
- interfaceAttachment: interfaceAttachment
- port_id: port_id
- net_id: net_id
- fixed_ips: fixed_ips
**Example Create Interface: JSON request**
.. literalinclude:: ../../doc/api_samples/os-attach-interfaces/attach-interfaces-create-req.json
:language: javascript
Response
--------
.. rest_parameters:: parameters.yaml
- interfaceAttachment: interfaceAttachment
- fixed_ips: fixed_ips
- mac_addr: mac_addr
- net_id: net_id
- port_id: port_id
- port_state: port_state
**Example Create Interface: JSON response**
.. literalinclude:: ../../doc/api_samples/os-attach-interfaces/attach-interfaces-create-resp.json
:language: javascript
Show Port Interface Details
===========================
.. rest_method:: GET /v2.1/{tenant_id}/servers/{server_id}/os-interface/{port_id}
Shows details for a port interface that is attached to a server.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
Request
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- server_id: server_id
- port_id: port_id
Response
--------
**Example Show Port Interface Details: JSON response**
.. literalinclude:: ../../doc/api_samples/os-attach-interfaces/attach-interfaces-show-resp.json
:language: javascript
Detach Interface
================
.. rest_method:: DELETE /v2.1/{tenant_id}/servers/{server_id}/os-interface/{port_id}
Detaches a port interface.
Normal response codes: 202
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404),
conflict(409), NotImplemented(501)
Request
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- server_id: server_id
- port_id: port_id
Response
--------