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

描述
VirtualMachineExport defines the operation of exporting a VM source
类型
object
必填
spec

规格

属性类型描述
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

描述
VirtualMachineExportSpec is the spec for a VirtualMachineExport resource
类型
object
必填
source
属性类型描述
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

描述
TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace.
类型
object
必填
kindname
属性类型描述
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

描述
VirtualMachineExportStatus is the status for a VirtualMachineExport resource
类型
object
属性类型描述
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

类型
array

.status.conditions[]

描述
Condition defines conditions
类型
object
必填
statustype
属性类型描述
lastProbeTimestring
lastTransitionTimestring
messagestring
reasonstring
statusstring
typestring

ConditionType is the const type for Conditions

描述
VirtualMachineExportLinks contains the links that point the exported VM resources
类型
object
属性类型描述
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

描述
VirtualMachineExportLink contains a list of volumes available for export, as well as the URLs to obtain these volumes
类型
object
必填
cert
属性类型描述
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

描述
Manifests is a list of available manifests for the export
类型
array

.status.links.external.manifests[]

描述
VirtualMachineExportManifest contains the type and URL of the exported manifest
类型
object
必填
typeurl
属性类型描述
typestring

Type is the type of manifest returned

urlstring

Url is the url of the endpoint that returns the manifest

.status.links.external.volumes

描述
Volumes is a list of available volumes to export
类型
array

.status.links.external.volumes[]

描述
VirtualMachineExportVolume contains the name and available formats for the exported volume
类型
object
必填
name
属性类型描述
formatsarray
namestring

Name is the name of the exported volume

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

类型
array

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

描述
VirtualMachineExportVolumeFormat contains the format type and URL to get the volume in that format
类型
object
必填
formaturl
属性类型描述
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

描述
VirtualMachineExportLink contains a list of volumes available for export, as well as the URLs to obtain these volumes
类型
object
必填
cert
属性类型描述
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

描述
Manifests is a list of available manifests for the export
类型
array

.status.links.internal.manifests[]

描述
VirtualMachineExportManifest contains the type and URL of the exported manifest
类型
object
必填
typeurl
属性类型描述
typestring

Type is the type of manifest returned

urlstring

Url is the url of the endpoint that returns the manifest

.status.links.internal.volumes

描述
Volumes is a list of available volumes to export
类型
array

.status.links.internal.volumes[]

描述
VirtualMachineExportVolume contains the name and available formats for the exported volume
类型
object
必填
name
属性类型描述
formatsarray
namestring

Name is the name of the exported volume

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

类型
array

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

描述
VirtualMachineExportVolumeFormat contains the format type and URL to get the volume in that format
类型
object
必填
formaturl
属性类型描述
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 端点

可用的 API 端点如下:

  • /apis/export.kubevirt.io/v1beta1/namespaces/{namespace}/virtualmachineexports
    • DELETE: delete collection of VirtualMachineExport
    • GET: list objects of kind VirtualMachineExport
    • POST: create a new VirtualMachineExport
  • /apis/export.kubevirt.io/v1beta1/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/v1beta1/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/v1beta1/namespaces/{namespace}/virtualmachineexports

HTTP 方法
DELETE
描述
delete collection of VirtualMachineExport
HTTP 响应
HTTP 状态码响应体
200 - OKStatus schema
401 - UnauthorizedEmpty
HTTP 方法
GET
描述
list objects of kind VirtualMachineExport
HTTP 响应
HTTP 状态码响应体
200 - OKVirtualMachineExportList schema
401 - UnauthorizedEmpty
HTTP 方法
POST
描述
create a new VirtualMachineExport
查询参数
参数类型描述
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.
请求体参数
参数类型描述
bodyVirtualMachineExport schemaapplication/json formatted
HTTP 响应
HTTP 状态码响应体
200 - OKVirtualMachineExport schema
201 - CreatedVirtualMachineExport schema
202 - AcceptedVirtualMachineExport schema
401 - UnauthorizedEmpty

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

HTTP 方法
DELETE
描述
delete the specified VirtualMachineExport
查询参数
参数类型描述
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 响应
HTTP 状态码响应体
200 - OKStatus schema
202 - AcceptedStatus schema
401 - UnauthorizedEmpty
HTTP 方法
GET
描述
read the specified VirtualMachineExport
HTTP 响应
HTTP 状态码响应体
200 - OKVirtualMachineExport schema
401 - UnauthorizedEmpty
HTTP 方法
PATCH
描述
partially update the specified VirtualMachineExport
查询参数
参数类型描述
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 响应
HTTP 状态码响应体
200 - OKVirtualMachineExport schema
401 - UnauthorizedEmpty
HTTP 方法
PUT
描述
replace the specified VirtualMachineExport
查询参数
参数类型描述
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.
请求体参数
参数类型描述
bodyVirtualMachineExport schemaapplication/json formatted
HTTP 响应
HTTP 状态码响应体
200 - OKVirtualMachineExport schema
201 - CreatedVirtualMachineExport schema
401 - UnauthorizedEmpty

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

HTTP 方法
GET
描述
read status of the specified VirtualMachineExport
HTTP 响应
HTTP 状态码响应体
200 - OKVirtualMachineExport schema
401 - UnauthorizedEmpty
HTTP 方法
PATCH
描述
partially update status of the specified VirtualMachineExport
查询参数
参数类型描述
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 响应
HTTP 状态码响应体
200 - OKVirtualMachineExport schema
401 - UnauthorizedEmpty
HTTP 方法
PUT
描述
replace status of the specified VirtualMachineExport
查询参数
参数类型描述
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.
请求体参数
参数类型描述
bodyVirtualMachineExport schemaapplication/json formatted
HTTP 响应
HTTP 状态码响应体
200 - OKVirtualMachineExport schema
201 - CreatedVirtualMachineExport schema
401 - UnauthorizedEmpty