diff --git a/api-ref/source/os-virtual-interfaces.inc b/api-ref/source/os-virtual-interfaces.inc index bfdf33a0bc..10bb6927f9 100644 --- a/api-ref/source/os-virtual-interfaces.inc +++ b/api-ref/source/os-virtual-interfaces.inc @@ -1,7 +1,4 @@ .. -*- rst -*- -.. needs:parameter_verification -.. needs:example_verification -.. needs:body_verification ============================================================= Servers virtual interfaces (servers, os-virtual-interfaces) @@ -16,7 +13,9 @@ List 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. +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 @@ -28,7 +27,7 @@ Request .. rest_parameters:: parameters.yaml - - server_id: server_id + - server_id: server_id_path Response -------- @@ -38,9 +37,18 @@ Response - virtual_interfaces: virtual_interfaces - id: virtual_interface_id - mac_address: mac_address + - net_id: net_id_resp_2_12 + +.. note:: + + The API v2 returns the network ID in the "OS-EXT-VIF-NET:net_id" response + attribute. But API v2.1 base version does not return the network ID. + Network ID has been added in v2.12 micro-version and returns it in the + "net_id" attribute. + **Example List Virtual Interfaces: JSON response** -.. literalinclude:: ../../doc/api_samples/os-virtual-interfaces/vifs-list-resp.json +.. literalinclude:: ../../doc/api_samples/os-virtual-interfaces/v2.12/vifs-list-resp.json :language: javascript diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml index d475025eee..99c5729370 100644 --- a/api-ref/source/parameters.yaml +++ b/api-ref/source/parameters.yaml @@ -2979,6 +2979,13 @@ net_id_resp: in: body required: true type: string +net_id_resp_2_12: + description: | + The network ID. + in: body + required: true + type: string + min_version: 2.12 network_label_body: description: | The network label, such as ``public`` or ``private``. @@ -4355,7 +4362,7 @@ virtual_interface_id_optional: type: string virtual_interfaces: description: | - A ``virtual_interfaces`` object. + An array of virtual interfaces. in: body required: true type: array