nova/api-ref/source/os-virtual-interfaces.inc
jichenjc ff00644cbd Complete Verification of os-virtual-interfaces
verified the API doc for os-virtual-interfaces,
Also, remove some common error code like 500, 503 etc

Part of bp:api-ref-in-rst

Change-Id: Iaaae9932d27d8fe7db529d101536bcd3dacb33cb
2016-04-23 22:31:48 +08:00

47 lines
1.2 KiB
ReStructuredText

.. -*- rst -*-
.. needs:parameter_verification
.. needs:example_verification
.. needs:body_verification
=============================================================
Servers virtual interfaces (servers, os-virtual-interfaces)
=============================================================
Lists virtual interfaces for a server instance.
List Virtual Interfaces
=======================
.. rest_method:: GET /v2.1/{tenant_id}/servers/{server_id}/os-virtual-interfaces
Lists the virtual interfaces for an instance.
Policy defaults enable only users with the administrative role or the owner of the server to perform this operation. Change these permissions through the ``policy.json`` file.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404)
Request
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- server_id: server_id
Response
--------
.. rest_parameters:: parameters.yaml
- virtual_interfaces: virtual_interfaces
- id: virtual_interface_id
- mac_address: mac_address
**Example List Virtual Interfaces: JSON response**
.. literalinclude:: ../../doc/api_samples/os-virtual-interfaces/vifs-list-resp.json
:language: javascript