1
0
mirror of https://github.com/GNS3/gns3-server synced 2024-12-04 22:28:12 +00:00
gns3-server/docs/api/v2/controller/compute/sid.rst

91 lines
6.6 KiB
ReStructuredText
Raw Normal View History

2016-06-04 08:40:39 +00:00
/v2/computes/{compute_id}
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
PUT /v2/computes/**{compute_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Get a compute server information
Response status codes
**********************
- **200**: Compute server updated
- **400**: Invalid request
- **404**: Instance doesn't exist
Input
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>compute_id</td> <td> </td> <td>string</td> <td>Server identifier</td> </tr>
<tr><td>host</td> <td> </td> <td>string</td> <td>Server host</td> </tr>
<tr><td>name</td> <td> </td> <td>string</td> <td>Server name</td> </tr>
<tr><td>password</td> <td> </td> <td>['string', 'null']</td> <td>Password for authentication</td> </tr>
<tr><td>port</td> <td> </td> <td>integer</td> <td>Server port</td> </tr>
<tr><td>protocol</td> <td> </td> <td>enum</td> <td>Possible values: http, https</td> </tr>
<tr><td>user</td> <td> </td> <td>['string', 'null']</td> <td>User for authentication</td> </tr>
</table>
Output
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
2016-08-29 13:58:29 +00:00
<tr><td>capabilities</td> <td> </td> <td>object</td> <td>Get what a server support</td> </tr>
2016-06-04 08:40:39 +00:00
<tr><td>compute_id</td> <td>&#10004;</td> <td>string</td> <td>Server identifier</td> </tr>
2016-07-11 13:37:57 +00:00
<tr><td>connected</td> <td> </td> <td>boolean</td> <td>Whether the controller is connected to the compute server or not</td> </tr>
<tr><td>cpu_usage_percent</td> <td> </td> <td>['number', 'null']</td> <td>CPU usage of the compute. Read only</td> </tr>
2016-06-04 08:40:39 +00:00
<tr><td>host</td> <td>&#10004;</td> <td>string</td> <td>Server host</td> </tr>
2016-07-11 13:37:57 +00:00
<tr><td>memory_usage_percent</td> <td> </td> <td>['number', 'null']</td> <td>RAM usage of the compute. Read only</td> </tr>
2016-06-04 08:40:39 +00:00
<tr><td>name</td> <td>&#10004;</td> <td>string</td> <td>Server name</td> </tr>
<tr><td>port</td> <td>&#10004;</td> <td>integer</td> <td>Server port</td> </tr>
<tr><td>protocol</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: http, https</td> </tr>
<tr><td>user</td> <td> </td> <td>['string', 'null']</td> <td>User for authentication</td> </tr>
</table>
GET /v2/computes/**{compute_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Get a compute server information
Response status codes
**********************
- **200**: Compute server information returned
Output
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
2016-08-29 13:58:29 +00:00
<tr><td>capabilities</td> <td> </td> <td>object</td> <td>Get what a server support</td> </tr>
2016-06-04 08:40:39 +00:00
<tr><td>compute_id</td> <td>&#10004;</td> <td>string</td> <td>Server identifier</td> </tr>
2016-07-11 13:37:57 +00:00
<tr><td>connected</td> <td> </td> <td>boolean</td> <td>Whether the controller is connected to the compute server or not</td> </tr>
<tr><td>cpu_usage_percent</td> <td> </td> <td>['number', 'null']</td> <td>CPU usage of the compute. Read only</td> </tr>
2016-06-04 08:40:39 +00:00
<tr><td>host</td> <td>&#10004;</td> <td>string</td> <td>Server host</td> </tr>
2016-07-11 13:37:57 +00:00
<tr><td>memory_usage_percent</td> <td> </td> <td>['number', 'null']</td> <td>RAM usage of the compute. Read only</td> </tr>
2016-06-04 08:40:39 +00:00
<tr><td>name</td> <td>&#10004;</td> <td>string</td> <td>Server name</td> </tr>
<tr><td>port</td> <td>&#10004;</td> <td>integer</td> <td>Server port</td> </tr>
<tr><td>protocol</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: http, https</td> </tr>
<tr><td>user</td> <td> </td> <td>['string', 'null']</td> <td>User for authentication</td> </tr>
</table>
DELETE /v2/computes/**{compute_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Delete a compute instance
Parameters
**********
- **compute_id**: Compute UUID
Response status codes
**********************
2018-01-08 08:26:44 +00:00
- **204**: Instance deleted
2016-06-04 08:40:39 +00:00
- **400**: Invalid request
- **404**: Instance doesn't exist