mirror of
https://github.com/GNS3/gns3-server
synced 2024-12-01 04:38:12 +00:00
146 lines
9.1 KiB
ReStructuredText
146 lines
9.1 KiB
ReStructuredText
/v2/compute/projects/{project_id}/cloud/nodes/{node_id}
|
|
------------------------------------------------------------------------------------------------------------------------------------------
|
|
|
|
.. contents::
|
|
|
|
GET /v2/compute/projects/**{project_id}**/cloud/nodes/**{node_id}**
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
Get a cloud instance
|
|
|
|
Parameters
|
|
**********
|
|
- **project_id**: Project UUID
|
|
- **node_id**: Node UUID
|
|
|
|
Response status codes
|
|
**********************
|
|
- **200**: Success
|
|
- **400**: Invalid request
|
|
- **404**: Instance doesn't exist
|
|
|
|
Output
|
|
*******
|
|
.. raw:: html
|
|
|
|
<table>
|
|
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
|
<tr><td>interfaces</td> <td> </td> <td>array</td> <td></td> </tr>
|
|
<tr><td>name</td> <td>✔</td> <td>string</td> <td>Cloud name</td> </tr>
|
|
<tr><td>node_directory</td> <td> </td> <td>string</td> <td>Path to the VM working directory</td> </tr>
|
|
<tr><td>node_id</td> <td>✔</td> <td>string</td> <td>Node UUID</td> </tr>
|
|
<tr><td>ports_mapping</td> <td>✔</td> <td>array</td> <td></td> </tr>
|
|
<tr><td>project_id</td> <td>✔</td> <td>string</td> <td>Project UUID</td> </tr>
|
|
<tr><td>remote_console_host</td> <td> </td> <td>['string']</td> <td>Remote console host or IP</td> </tr>
|
|
<tr><td>remote_console_http_path</td> <td> </td> <td>string</td> <td>Path of the remote web interface</td> </tr>
|
|
<tr><td>remote_console_port</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</td> </tr>
|
|
<tr><td>remote_console_type</td> <td> </td> <td>enum</td> <td>Possible values: telnet, vnc, spice, http, https, none</td> </tr>
|
|
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: started, stopped, suspended</td> </tr>
|
|
</table>
|
|
|
|
Sample session
|
|
***************
|
|
|
|
|
|
.. literalinclude:: ../../../examples/compute_get_projectsprojectidcloudnodesnodeid.txt
|
|
|
|
|
|
PUT /v2/compute/projects/**{project_id}**/cloud/nodes/**{node_id}**
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
Update a cloud instance
|
|
|
|
Parameters
|
|
**********
|
|
- **project_id**: Project UUID
|
|
- **node_id**: Node UUID
|
|
|
|
Response status codes
|
|
**********************
|
|
- **200**: Instance updated
|
|
- **400**: Invalid request
|
|
- **404**: Instance doesn't exist
|
|
- **409**: Conflict
|
|
|
|
Input
|
|
*******
|
|
Types
|
|
+++++++++
|
|
HostInterfaces
|
|
^^^^^^^^^^^^^^^^^^^^^^
|
|
Interfaces on this host
|
|
|
|
.. raw:: html
|
|
|
|
<table>
|
|
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
|
<tr><td>name</td> <td>✔</td> <td>string</td> <td>Interface name</td> </tr>
|
|
<tr><td>special</td> <td>✔</td> <td>boolean</td> <td>If true the interface is non standard (firewire for example)</td> </tr>
|
|
<tr><td>type</td> <td>✔</td> <td>enum</td> <td>Possible values: ethernet, tap</td> </tr>
|
|
</table>
|
|
|
|
Body
|
|
+++++++++
|
|
.. raw:: html
|
|
|
|
<table>
|
|
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
|
<tr><td>interfaces</td> <td> </td> <td>array</td> <td></td> </tr>
|
|
<tr><td>name</td> <td> </td> <td>string</td> <td>Cloud name</td> </tr>
|
|
<tr><td>node_directory</td> <td> </td> <td>string</td> <td>Path to the VM working directory</td> </tr>
|
|
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node UUID</td> </tr>
|
|
<tr><td>ports_mapping</td> <td> </td> <td>array</td> <td></td> </tr>
|
|
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
|
|
<tr><td>remote_console_host</td> <td> </td> <td>['string']</td> <td>Remote console host or IP</td> </tr>
|
|
<tr><td>remote_console_http_path</td> <td> </td> <td>string</td> <td>Path of the remote web interface</td> </tr>
|
|
<tr><td>remote_console_port</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</td> </tr>
|
|
<tr><td>remote_console_type</td> <td> </td> <td>enum</td> <td>Possible values: telnet, vnc, spice, http, https, none</td> </tr>
|
|
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: started, stopped, suspended</td> </tr>
|
|
</table>
|
|
|
|
Output
|
|
*******
|
|
.. raw:: html
|
|
|
|
<table>
|
|
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
|
<tr><td>interfaces</td> <td> </td> <td>array</td> <td></td> </tr>
|
|
<tr><td>name</td> <td>✔</td> <td>string</td> <td>Cloud name</td> </tr>
|
|
<tr><td>node_directory</td> <td> </td> <td>string</td> <td>Path to the VM working directory</td> </tr>
|
|
<tr><td>node_id</td> <td>✔</td> <td>string</td> <td>Node UUID</td> </tr>
|
|
<tr><td>ports_mapping</td> <td>✔</td> <td>array</td> <td></td> </tr>
|
|
<tr><td>project_id</td> <td>✔</td> <td>string</td> <td>Project UUID</td> </tr>
|
|
<tr><td>remote_console_host</td> <td> </td> <td>['string']</td> <td>Remote console host or IP</td> </tr>
|
|
<tr><td>remote_console_http_path</td> <td> </td> <td>string</td> <td>Path of the remote web interface</td> </tr>
|
|
<tr><td>remote_console_port</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</td> </tr>
|
|
<tr><td>remote_console_type</td> <td> </td> <td>enum</td> <td>Possible values: telnet, vnc, spice, http, https, none</td> </tr>
|
|
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: started, stopped, suspended</td> </tr>
|
|
</table>
|
|
|
|
Sample session
|
|
***************
|
|
|
|
|
|
.. literalinclude:: ../../../examples/compute_put_projectsprojectidcloudnodesnodeid.txt
|
|
|
|
|
|
DELETE /v2/compute/projects/**{project_id}**/cloud/nodes/**{node_id}**
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
Delete a cloud instance
|
|
|
|
Parameters
|
|
**********
|
|
- **project_id**: Project UUID
|
|
- **node_id**: Node UUID
|
|
|
|
Response status codes
|
|
**********************
|
|
- **204**: Instance deleted
|
|
- **400**: Invalid request
|
|
- **404**: Instance doesn't exist
|
|
|
|
Sample session
|
|
***************
|
|
|
|
|
|
.. literalinclude:: ../../../examples/compute_delete_projectsprojectidcloudnodesnodeid.txt
|
|
|