Alauda Container Platform

VirtualMachineExport [virtualmachineexports.export.kubevirt.io/v1beta1]

Description
VirtualMachineExport defines the operation of exporting a VM source
Type
object
Required
spec

Specification

PropertyTypeDescription
apiVersionstring

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kindstring

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadataObjectMeta

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

specobject

VirtualMachineExportSpec is the spec for a VirtualMachineExport resource

statusobject

VirtualMachineExportStatus is the status for a VirtualMachineExport resource

.spec

Description
VirtualMachineExportSpec is the spec for a VirtualMachineExport resource
Type
object
Required
source
PropertyTypeDescription
sourceobject

TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace.

tokenSecretRefstring

TokenSecretRef is the name of the custom-defined secret that contains the token used by the export server pod

ttlDurationstring

ttlDuration limits the lifetime of an export If this field is set, after this duration has passed from counting from CreationTimestamp, the export is eligible to be automatically deleted. If this field is omitted, a reasonable default is applied.

.spec.source

Description
TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace.
Type
object
Required
kindname
PropertyTypeDescription
apiGroupstring

APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.

kindstring

Kind is the type of resource being referenced

namestring

Name is the name of resource being referenced

.status

Description
VirtualMachineExportStatus is the status for a VirtualMachineExport resource
Type
object
PropertyTypeDescription
conditionsarray
linksobject

VirtualMachineExportLinks contains the links that point the exported VM resources

phasestring

VirtualMachineExportPhase is the current phase of the VirtualMachineExport

serviceNamestring

ServiceName is the name of the service created associated with the Virtual Machine export. It will be used to create the internal URLs for downloading the images

tokenSecretRefstring

TokenSecretRef is the name of the secret that contains the token used by the export server pod

ttlExpirationTimestring

The time at which the VM Export will be completely removed according to specified TTL Formula is CreationTimestamp + TTL

virtualMachineNamestring

VirtualMachineName shows the name of the source virtual machine if the source is either a VirtualMachine or a VirtualMachineSnapshot. This is mainly to easily identify the source VirtualMachine in case of a VirtualMachineSnapshot

.status.conditions

Type
array

.status.conditions[]

Description
Condition defines conditions
Type
object
Required
statustype
PropertyTypeDescription
lastProbeTimestring
lastTransitionTimestring
messagestring
reasonstring
statusstring
typestring

ConditionType is the const type for Conditions

Description
VirtualMachineExportLinks contains the links that point the exported VM resources
Type
object
PropertyTypeDescription
externalobject

VirtualMachineExportLink contains a list of volumes available for export, as well as the URLs to obtain these volumes

internalobject

VirtualMachineExportLink contains a list of volumes available for export, as well as the URLs to obtain these volumes

.status.links.external

Description
VirtualMachineExportLink contains a list of volumes available for export, as well as the URLs to obtain these volumes
Type
object
Required
cert
PropertyTypeDescription
certstring

Cert is the public CA certificate base64 encoded

manifestsarray

Manifests is a list of available manifests for the export

volumesarray

Volumes is a list of available volumes to export

.status.links.external.manifests

Description
Manifests is a list of available manifests for the export
Type
array

.status.links.external.manifests[]

Description
VirtualMachineExportManifest contains the type and URL of the exported manifest
Type
object
Required
typeurl
PropertyTypeDescription
typestring

Type is the type of manifest returned

urlstring

Url is the url of the endpoint that returns the manifest

.status.links.external.volumes

Description
Volumes is a list of available volumes to export
Type
array

.status.links.external.volumes[]

Description
VirtualMachineExportVolume contains the name and available formats for the exported volume
Type
object
Required
name
PropertyTypeDescription
formatsarray
namestring

Name is the name of the exported volume

.status.links.external.volumes[].formats

Type
array

.status.links.external.volumes[].formats[]

Description
VirtualMachineExportVolumeFormat contains the format type and URL to get the volume in that format
Type
object
Required
formaturl
PropertyTypeDescription
formatstring

Format is the format of the image at the specified URL

urlstring

Url is the url that contains the volume in the format specified

.status.links.internal

Description
VirtualMachineExportLink contains a list of volumes available for export, as well as the URLs to obtain these volumes
Type
object
Required
cert
PropertyTypeDescription
certstring

Cert is the public CA certificate base64 encoded

manifestsarray

Manifests is a list of available manifests for the export

volumesarray

Volumes is a list of available volumes to export

.status.links.internal.manifests

Description
Manifests is a list of available manifests for the export
Type
array

.status.links.internal.manifests[]

Description
VirtualMachineExportManifest contains the type and URL of the exported manifest
Type
object
Required
typeurl
PropertyTypeDescription
typestring

Type is the type of manifest returned

urlstring

Url is the url of the endpoint that returns the manifest

.status.links.internal.volumes

Description
Volumes is a list of available volumes to export
Type
array

.status.links.internal.volumes[]

Description
VirtualMachineExportVolume contains the name and available formats for the exported volume
Type
object
Required
name
PropertyTypeDescription
formatsarray
namestring

Name is the name of the exported volume

.status.links.internal.volumes[].formats

Type
array

.status.links.internal.volumes[].formats[]

Description
VirtualMachineExportVolumeFormat contains the format type and URL to get the volume in that format
Type
object
Required
formaturl
PropertyTypeDescription
formatstring

Format is the format of the image at the specified URL

urlstring

Url is the url that contains the volume in the format specified

API Endpoints

The following API endpoints are available:

  • /apis/export.kubevirt.io/v1alpha1/namespaces/{namespace}/virtualmachineexports
    • DELETE: delete collection of VirtualMachineExport
    • GET: list objects of kind VirtualMachineExport
    • POST: create a new VirtualMachineExport
  • /apis/export.kubevirt.io/v1alpha1/namespaces/{namespace}/virtualmachineexports/{name}
    • DELETE: delete the specified VirtualMachineExport
    • GET: read the specified VirtualMachineExport
    • PATCH: partially update the specified VirtualMachineExport
    • PUT: replace the specified VirtualMachineExport
  • /apis/export.kubevirt.io/v1alpha1/namespaces/{namespace}/virtualmachineexports/{name}/status
    • GET: read status of the specified VirtualMachineExport
    • PATCH: partially update status of the specified VirtualMachineExport
    • PUT: replace status of the specified VirtualMachineExport

/apis/export.kubevirt.io/v1alpha1/namespaces/{namespace}/virtualmachineexports

HTTP method
DELETE
Description
delete collection of VirtualMachineExport
HTTP responses
HTTP codeResponse body
200 - OKStatus schema
401 - UnauthorizedEmpty
HTTP method
GET
Description
list objects of kind VirtualMachineExport
HTTP responses
HTTP codeResponse body
200 - OKVirtualMachineExportList schema
401 - UnauthorizedEmpty
HTTP method
POST
Description
create a new VirtualMachineExport
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
Body parameters
ParameterTypeDescription
bodyVirtualMachineExport schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKVirtualMachineExport schema
201 - CreatedVirtualMachineExport schema
202 - AcceptedVirtualMachineExport schema
401 - UnauthorizedEmpty

/apis/export.kubevirt.io/v1alpha1/namespaces/{namespace}/virtualmachineexports/{name}

HTTP method
DELETE
Description
delete the specified VirtualMachineExport
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
HTTP responses
HTTP codeResponse body
200 - OKStatus schema
202 - AcceptedStatus schema
401 - UnauthorizedEmpty
HTTP method
GET
Description
read the specified VirtualMachineExport
HTTP responses
HTTP codeResponse body
200 - OKVirtualMachineExport schema
401 - UnauthorizedEmpty
HTTP method
PATCH
Description
partially update the specified VirtualMachineExport
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
HTTP responses
HTTP codeResponse body
200 - OKVirtualMachineExport schema
401 - UnauthorizedEmpty
HTTP method
PUT
Description
replace the specified VirtualMachineExport
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
Body parameters
ParameterTypeDescription
bodyVirtualMachineExport schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKVirtualMachineExport schema
201 - CreatedVirtualMachineExport schema
401 - UnauthorizedEmpty

/apis/export.kubevirt.io/v1alpha1/namespaces/{namespace}/virtualmachineexports/{name}/status

HTTP method
GET
Description
read status of the specified VirtualMachineExport
HTTP responses
HTTP codeResponse body
200 - OKVirtualMachineExport schema
401 - UnauthorizedEmpty
HTTP method
PATCH
Description
partially update status of the specified VirtualMachineExport
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
HTTP responses
HTTP codeResponse body
200 - OKVirtualMachineExport schema
401 - UnauthorizedEmpty
HTTP method
PUT
Description
replace status of the specified VirtualMachineExport
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
Body parameters
ParameterTypeDescription
bodyVirtualMachineExport schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKVirtualMachineExport schema
201 - CreatedVirtualMachineExport schema
401 - UnauthorizedEmpty