Alauda Container Platform

VirtualMachineStorageMigration [virtualmachinestoragemigrations.migrations.kubevirt.io/v1alpha1]

Description
VirtualMachineStorageMigration is the Schema for the virtualmachinestoragemigrations API
Type
object

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

MigMigrationSpec defines the desired state of MigMigration

statusobject

VirtualMachineStorageMigrationStatus defines the observed state of VirtualMachineStorageMigration

.spec

Description
MigMigrationSpec defines the desired state of MigMigration
Type
object
Required
virtualMachineStorageMigrationPlanRef
PropertyTypeDescription
virtualMachineStorageMigrationPlanRefobject

ObjectReference contains enough information to let you inspect or modify the referred object.

.spec.virtualMachineStorageMigrationPlanRef

Description
ObjectReference contains enough information to let you inspect or modify the referred object.
Type
object
PropertyTypeDescription
apiVersionstring

API version of the referent.

fieldPathstring

If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.

kindstring

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

namestring

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

namespacestring

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

resourceVersionstring

Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

uidstring

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

.status

Description
VirtualMachineStorageMigrationStatus defines the observed state of VirtualMachineStorageMigration
Type
object
PropertyTypeDescription
cancelledMigrationsarray

The cancelled migrations.

completedMigrationsarray

The completed migrations.

conditionsarray
errorsarray

The errors occurred during the migration.

phasestring

The current phase of the migration.

runningMigrationsarray

The running migrations.

.status.cancelledMigrations

Description
The cancelled migrations.
Type
array

.status.cancelledMigrations[]

Type
string

.status.completedMigrations

Description
The completed migrations.
Type
array

.status.completedMigrations[]

Type
string

.status.conditions

Type
array

.status.conditions[]

Description
Condition Type - The condition type. Status - The condition status. Reason - The reason for the condition. Message - The human readable description of the condition. Durable - The condition is not un-staged. Items - A list of `items` associated with the condition used to replace [] in `Message`. staging - A condition has been explicitly set/updated.
Type
object
Required
categorylastTransitionTimestatustype
PropertyTypeDescription
categorystring
lastTransitionTimestring
messagestring
reasonstring
statusstring
typestring

.status.errors

Description
The errors occurred during the migration.
Type
array

.status.errors[]

Type
string

.status.runningMigrations

Description
The running migrations.
Type
array

.status.runningMigrations[]

Description
RunningVirtualMachineMigration has the name of the VirtualMachine and the progress of the migration.
Type
object
Required
name
PropertyTypeDescription
namestring

The name of the VirtualMachine.

progressstring

The progress of the migration.

API Endpoints

The following API endpoints are available:

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

/apis/migrations.kubevirt.io/v1alpha1/namespaces/{namespace}/virtualmachinestoragemigrations

HTTP method
DELETE
Description
delete collection of VirtualMachineStorageMigration
HTTP responses
HTTP codeResponse body
200 - OKStatus schema
401 - UnauthorizedEmpty
HTTP method
GET
Description
list objects of kind VirtualMachineStorageMigration
HTTP responses
HTTP codeResponse body
200 - OKVirtualMachineStorageMigrationList schema
401 - UnauthorizedEmpty
HTTP method
POST
Description
create a new VirtualMachineStorageMigration
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
bodyVirtualMachineStorageMigration schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKVirtualMachineStorageMigration schema
201 - CreatedVirtualMachineStorageMigration schema
202 - AcceptedVirtualMachineStorageMigration schema
401 - UnauthorizedEmpty

/apis/migrations.kubevirt.io/v1alpha1/namespaces/{namespace}/virtualmachinestoragemigrations/{name}

HTTP method
DELETE
Description
delete the specified VirtualMachineStorageMigration
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 VirtualMachineStorageMigration
HTTP responses
HTTP codeResponse body
200 - OKVirtualMachineStorageMigration schema
401 - UnauthorizedEmpty
HTTP method
PATCH
Description
partially update the specified VirtualMachineStorageMigration
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 - OKVirtualMachineStorageMigration schema
401 - UnauthorizedEmpty
HTTP method
PUT
Description
replace the specified VirtualMachineStorageMigration
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
bodyVirtualMachineStorageMigration schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKVirtualMachineStorageMigration schema
201 - CreatedVirtualMachineStorageMigration schema
401 - UnauthorizedEmpty

/apis/migrations.kubevirt.io/v1alpha1/namespaces/{namespace}/virtualmachinestoragemigrations/{name}/status

HTTP method
GET
Description
read status of the specified VirtualMachineStorageMigration
HTTP responses
HTTP codeResponse body
200 - OKVirtualMachineStorageMigration schema
401 - UnauthorizedEmpty
HTTP method
PATCH
Description
partially update status of the specified VirtualMachineStorageMigration
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 - OKVirtualMachineStorageMigration schema
401 - UnauthorizedEmpty
HTTP method
PUT
Description
replace status of the specified VirtualMachineStorageMigration
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
bodyVirtualMachineStorageMigration schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKVirtualMachineStorageMigration schema
201 - CreatedVirtualMachineStorageMigration schema
401 - UnauthorizedEmpty