1a7539c1f5
update api based latest master. Signed-off-by: Jose Carlos Venegas Munoz <jose.carlos.venegas.munoz@intel.com>
7.3 KiB
\DefaultApi
All URIs are relative to http://localhost/api/v1
| Method | HTTP request | Description |
|---|---|---|
| BootVM | Put /vm.boot | Boot the previously created VM instance. |
| CreateVM | Put /vm.create | Create the cloud-hypervisor Virtual Machine (VM) instance. The instance is not booted, only created. |
| DeleteVM | Put /vm.delete | Delete the cloud-hypervisor Virtual Machine (VM) instance. |
| PauseVM | Put /vm.pause | Pause a previously booted VM instance. |
| RebootVM | Put /vm.reboot | Reboot the VM instance. |
| ResumeVM | Put /vm.resume | Resume a previously paused VM instance. |
| ShutdownVM | Put /vm.shutdown | Shut the VM instance down. |
| ShutdownVMM | Put /vmm.shutdown | Shuts the cloud-hypervisor VMM. |
| VmInfoGet | Get /vm.info | Returns general information about the cloud-hypervisor Virtual Machine (VM) instance. |
| VmResizePut | Put /vm.resize | Resize the VM |
| VmmPingGet | Get /vmm.ping | Ping the VMM to check for API server availability |
BootVM
BootVM(ctx, )
Boot the previously created VM instance.
Required Parameters
This endpoint does not need any parameter.
Return type
(empty response body)
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CreateVM
CreateVM(ctx, vmConfig)
Create the cloud-hypervisor Virtual Machine (VM) instance. The instance is not booted, only created.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| vmConfig | VmConfig | The VM configuration |
Return type
(empty response body)
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteVM
DeleteVM(ctx, )
Delete the cloud-hypervisor Virtual Machine (VM) instance.
Required Parameters
This endpoint does not need any parameter.
Return type
(empty response body)
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PauseVM
PauseVM(ctx, )
Pause a previously booted VM instance.
Required Parameters
This endpoint does not need any parameter.
Return type
(empty response body)
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RebootVM
RebootVM(ctx, )
Reboot the VM instance.
Required Parameters
This endpoint does not need any parameter.
Return type
(empty response body)
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResumeVM
ResumeVM(ctx, )
Resume a previously paused VM instance.
Required Parameters
This endpoint does not need any parameter.
Return type
(empty response body)
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ShutdownVM
ShutdownVM(ctx, )
Shut the VM instance down.
Required Parameters
This endpoint does not need any parameter.
Return type
(empty response body)
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ShutdownVMM
ShutdownVMM(ctx, )
Shuts the cloud-hypervisor VMM.
Required Parameters
This endpoint does not need any parameter.
Return type
(empty response body)
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
VmInfoGet
VmInfo VmInfoGet(ctx, )
Returns general information about the cloud-hypervisor Virtual Machine (VM) instance.
Required Parameters
This endpoint does not need any parameter.
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
VmResizePut
VmResizePut(ctx, vmResize)
Resize the VM
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| vmResize | VmResize | The target size for the VM |
Return type
(empty response body)
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
VmmPingGet
VmmPingResponse VmmPingGet(ctx, )
Ping the VMM to check for API server availability
Required Parameters
This endpoint does not need any parameter.
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]