kata-containers/src/runtime/virtcontainers/pkg/cloud-hypervisor/client

Go API client for openapi

Local HTTP based API for managing and inspecting a cloud-hypervisor virtual machine.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

• API version: 0.3.0
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context
go get github.com/antihax/optional

Put the package under your project folder and add the following in import:

import "./openapi"

Documentation for API Endpoints

All URIs are relative to http://localhost/api/v1

Class	Method	HTTP request	Description
DefaultApi	BootVM	Put /vm.boot	Boot the previously created VM instance.
DefaultApi	CreateVM	Put /vm.create	Create the cloud-hypervisor Virtual Machine (VM) instance. The instance is not booted, only created.
DefaultApi	DeleteVM	Put /vm.delete	Delete the cloud-hypervisor Virtual Machine (VM) instance.
DefaultApi	PauseVM	Put /vm.pause	Pause a previously booted VM instance.
DefaultApi	RebootVM	Put /vm.reboot	Reboot the VM instance.
DefaultApi	ResumeVM	Put /vm.resume	Resume a previously paused VM instance.
DefaultApi	ShutdownVM	Put /vm.shutdown	Shut the VM instance down.
DefaultApi	ShutdownVMM	Put /vmm.shutdown	Shuts the cloud-hypervisor VMM.
DefaultApi	VmAddDevicePut	Put /vm.add-device	Add a new device to the VM
DefaultApi	VmAddDiskPut	Put /vm.add-disk	Add a new disk to the VM
DefaultApi	VmAddFsPut	Put /vm.add-fs	Add a new virtio-fs device to the VM
DefaultApi	VmAddNetPut	Put /vm.add-net	Add a new network device to the VM
DefaultApi	VmAddPmemPut	Put /vm.add-pmem	Add a new pmem device to the VM
DefaultApi	VmAddVsockPut	Put /vm.add-vsock	Add a new vsock device to the VM
DefaultApi	VmCountersGet	Get /vm.counters	Get counters from the VM
DefaultApi	VmInfoGet	Get /vm.info	Returns general information about the cloud-hypervisor Virtual Machine (VM) instance.
DefaultApi	VmRemoveDevicePut	Put /vm.remove-device	Remove a device from the VM
DefaultApi	VmResizePut	Put /vm.resize	Resize the VM
DefaultApi	VmRestorePut	Put /vm.restore	Restore a VM from a snapshot.
DefaultApi	VmSnapshotPut	Put /vm.snapshot	Returns a VM snapshot.
DefaultApi	VmmPingGet	Get /vmm.ping	Ping the VMM to check for API server availability

Documentation For Models

• CmdLineConfig
• ConsoleConfig
• CpuTopology
• CpusConfig
• DeviceConfig
• DiskConfig
• FsConfig
• InitramfsConfig
• KernelConfig
• MemoryConfig
• NetConfig
• PciDeviceInfo
• PmemConfig
• RestoreConfig
• RngConfig
• SgxEpcConfig
• VmAddDevice
• VmConfig
• VmInfo
• VmRemoveDevice
• VmResize
• VmSnapshotConfig
• VmmPingResponse
• VsockConfig

Documentation For Authorization

Endpoints do not require authorization.

Author