mirror of
https://github.com/GNS3/gns3-server
synced 2024-12-12 01:58:14 +00:00
60 lines
5.1 KiB
ReStructuredText
60 lines
5.1 KiB
ReStructuredText
|
/v2/compute/projects/{project_id}/docker/vms/{id}/stop
|
||
|
|
------------------------------------------------------------------------------------------------------------------------------------------
|
||
|
|
|
||
|
|
.. contents::
|
||
|
|
|
||
|
|
POST /v2/compute/projects/**{project_id}**/docker/vms/**{id}**/stop
|
||
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||
|
|
Stop a Docker container
|
||
|
|
|
||
|
|
Parameters
|
||
|
|
**********
|
||
|
|
- **id**: ID of the container
|
||
|
|
- **project_id**: UUID of the project
|
||
|
|
|
||
|
|
Response status codes
|
||
|
|
**********************
|
||
|
|
- **400**: Invalid request
|
||
|
|
- **404**: Instance doesn't exist
|
||
|
|
- **204**: Instance stopped
|
||
|
|
|
||
|
|
Input
|
||
|
|
*******
|
||
|
|
.. raw:: html
|
||
|
|
|
||
|
|
<table>
|
||
|
|
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||
|
|
<tr><td>adapters</td> <td> </td> <td>['integer', 'null']</td> <td>number of adapters</td> </tr>
|
||
|
|
<tr><td>aux</td> <td> </td> <td>['integer', 'null']</td> <td>auxilary TCP port</td> </tr>
|
||
|
|
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>console TCP port</td> </tr>
|
||
|
|
<tr><td>console_resolution</td> <td> </td> <td>['string', 'null']</td> <td>console resolution for VNC</td> </tr>
|
||
|
|
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: telnet, vnc</td> </tr>
|
||
|
|
<tr><td>environment</td> <td> </td> <td>['string', 'null']</td> <td>Docker environment</td> </tr>
|
||
|
|
<tr><td>image</td> <td> </td> <td>string</td> <td>Docker image name</td> </tr>
|
||
|
|
<tr><td>name</td> <td> </td> <td>string</td> <td>Docker container name</td> </tr>
|
||
|
|
<tr><td>start_command</td> <td> </td> <td>['string', 'null']</td> <td>Docker CMD entry</td> </tr>
|
||
|
|
<tr><td>vm_id</td> <td> </td> <td>string</td> <td>Docker VM instance identifier</td> </tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
Output
|
||
|
|
*******
|
||
|
|
.. raw:: html
|
||
|
|
|
||
|
|
<table>
|
||
|
|
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||
|
|
<tr><td>adapters</td> <td>✔</td> <td>['integer', 'null']</td> <td>number of adapters</td> </tr>
|
||
|
|
<tr><td>aux</td> <td>✔</td> <td>integer</td> <td>auxilary TCP port</td> </tr>
|
||
|
|
<tr><td>console</td> <td>✔</td> <td>integer</td> <td>console TCP port</td> </tr>
|
||
|
|
<tr><td>console_resolution</td> <td>✔</td> <td>string</td> <td>console resolution for VNC</td> </tr>
|
||
|
|
<tr><td>console_type</td> <td>✔</td> <td>enum</td> <td>Possible values: telnet, vnc</td> </tr>
|
||
|
|
<tr><td>container_id</td> <td>✔</td> <td>string</td> <td>Docker container ID</td> </tr>
|
||
|
|
<tr><td>environment</td> <td>✔</td> <td>['string', 'null']</td> <td>Docker environment</td> </tr>
|
||
|
|
<tr><td>image</td> <td>✔</td> <td>string</td> <td>Docker image name</td> </tr>
|
||
|
|
<tr><td>name</td> <td> </td> <td>string</td> <td>Docker container name</td> </tr>
|
||
|
|
<tr><td>project_id</td> <td>✔</td> <td>string</td> <td>Project UUID</td> </tr>
|
||
|
|
<tr><td>start_command</td> <td>✔</td> <td>['string', 'null']</td> <td>Docker CMD entry</td> </tr>
|
||
|
|
<tr><td>vm_directory</td> <td>✔</td> <td>string</td> <td></td> </tr>
|
||
|
|
<tr><td>vm_id</td> <td>✔</td> <td>string</td> <td>Docker container instance UUID</td> </tr>
|
||
|
|
</table>
|
||
|
|
|