1
0
mirror of https://github.com/GNS3/gns3-server synced 2024-12-11 09:38:08 +00:00
gns3-server/docs/api/v2/compute/cloud/projectsprojectidcloudnodesnodeid.rst

134 lines
6.8 KiB
ReStructuredText
Raw Normal View History

2016-06-04 08:40:39 +00:00
/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
**********
2016-11-03 17:20:51 +00:00
- **project_id**: Project UUID
2017-03-06 13:35:39 +00:00
- **node_id**: Node UUID
2016-06-04 08:40:39 +00:00
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>
2017-03-06 13:35:39 +00:00
<tr><td>node_directory</td> <td> </td> <td>string</td> <td>Path to the VM working directory</td> </tr>
2016-06-04 08:40:39 +00:00
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node UUID</td> </tr>
2016-09-14 13:24:27 +00:00
<tr><td>ports_mapping</td> <td> </td> <td>array</td> <td></td> </tr>
2016-06-04 08:40:39 +00:00
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: started, stopped, suspended</td> </tr>
</table>
2017-03-21 12:32:04 +00:00
Sample session
***************
.. literalinclude:: ../../../examples/compute_get_projectsprojectidcloudnodesnodeid.txt
2016-06-04 08:40:39 +00:00
PUT /v2/compute/projects/**{project_id}**/cloud/nodes/**{node_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Update a cloud instance
Parameters
**********
2016-11-03 17:20:51 +00:00
- **project_id**: Project UUID
2017-03-06 13:35:39 +00:00
- **node_id**: Node UUID
2016-06-04 08:40:39 +00:00
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>&#10004;</td> <td>string</td> <td>Interface name</td> </tr>
2016-09-27 15:15:40 +00:00
<tr><td>special</td> <td>&#10004;</td> <td>boolean</td> <td>If true the interface is non standard (firewire for example)</td> </tr>
2016-06-04 08:40:39 +00:00
<tr><td>type</td> <td>&#10004;</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>
2017-03-06 13:35:39 +00:00
<tr><td>node_directory</td> <td> </td> <td>string</td> <td>Path to the VM working directory</td> </tr>
2016-06-04 08:40:39 +00:00
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node UUID</td> </tr>
2016-09-14 13:24:27 +00:00
<tr><td>ports_mapping</td> <td> </td> <td>array</td> <td></td> </tr>
2016-06-04 08:40:39 +00:00
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</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>
2017-03-06 13:35:39 +00:00
<tr><td>node_directory</td> <td> </td> <td>string</td> <td>Path to the VM working directory</td> </tr>
2016-06-04 08:40:39 +00:00
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node UUID</td> </tr>
2016-09-14 13:24:27 +00:00
<tr><td>ports_mapping</td> <td> </td> <td>array</td> <td></td> </tr>
2016-06-04 08:40:39 +00:00
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: started, stopped, suspended</td> </tr>
</table>
2017-03-21 12:32:04 +00:00
Sample session
***************
.. literalinclude:: ../../../examples/compute_put_projectsprojectidcloudnodesnodeid.txt
2016-06-04 08:40:39 +00:00
DELETE /v2/compute/projects/**{project_id}**/cloud/nodes/**{node_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Delete a cloud instance
Parameters
**********
2016-11-03 17:20:51 +00:00
- **project_id**: Project UUID
2017-03-06 13:35:39 +00:00
- **node_id**: Node UUID
2016-06-04 08:40:39 +00:00
Response status codes
**********************
2017-03-06 13:35:39 +00:00
- **204**: Instance deleted
2016-06-04 08:40:39 +00:00
- **400**: Invalid request
- **404**: Instance doesn't exist
2016-08-25 12:43:19 +00:00
2017-03-21 12:32:04 +00:00
Sample session
***************
.. literalinclude:: ../../../examples/compute_delete_projectsprojectidcloudnodesnodeid.txt