Alauda Container Platform

DataSource [datasources.cdi.kubevirt.io/v1beta1]

Description
DataSource references an import/clone source for a DataVolume
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

DataSourceSpec defines specification for DataSource

statusobject

DataSourceStatus provides the most recently observed status of the DataSource

.spec

Description
DataSourceSpec defines specification for DataSource
Type
object
Required
source
PropertyTypeDescription
sourceobject

Source is the source of the data referenced by the DataSource

.spec.source

Description
Source is the source of the data referenced by the DataSource
Type
object
PropertyTypeDescription
dataSourceobject

DataSourceRefSourceDataSource serves as a reference to another DataSource Can be resolved into a DataVolumeSourcePVC or a DataVolumeSourceSnapshot The maximum depth of a reference chain may not exceed 1.

pvcobject

DataVolumeSourcePVC provides the parameters to create a Data Volume from an existing PVC

snapshotobject

DataVolumeSourceSnapshot provides the parameters to create a Data Volume from an existing VolumeSnapshot

.spec.source.dataSource

Description
DataSourceRefSourceDataSource serves as a reference to another DataSource Can be resolved into a DataVolumeSourcePVC or a DataVolumeSourceSnapshot The maximum depth of a reference chain may not exceed 1.
Type
object
Required
namenamespace
PropertyTypeDescription
namestring

The name of the source DataSource

namespacestring

The namespace of the source DataSource

.spec.source.pvc

Description
DataVolumeSourcePVC provides the parameters to create a Data Volume from an existing PVC
Type
object
Required
namenamespace
PropertyTypeDescription
namestring

The name of the source PVC

namespacestring

The namespace of the source PVC

.spec.source.snapshot

Description
DataVolumeSourceSnapshot provides the parameters to create a Data Volume from an existing VolumeSnapshot
Type
object
Required
namenamespace
PropertyTypeDescription
namestring

The name of the source VolumeSnapshot

namespacestring

The namespace of the source VolumeSnapshot

.status

Description
DataSourceStatus provides the most recently observed status of the DataSource
Type
object
PropertyTypeDescription
conditionsarray
sourceobject

Source is the current source of the data referenced by the DataSource

.status.conditions

Type
array

.status.conditions[]

Description
DataSourceCondition represents the state of a data source condition
Type
object
Required
statustype
PropertyTypeDescription
lastHeartbeatTimestring
lastTransitionTimestring
messagestring
reasonstring
statusstring
typestring

DataSourceConditionType is the string representation of known condition types

.status.source

Description
Source is the current source of the data referenced by the DataSource
Type
object
PropertyTypeDescription
dataSourceobject

DataSourceRefSourceDataSource serves as a reference to another DataSource Can be resolved into a DataVolumeSourcePVC or a DataVolumeSourceSnapshot The maximum depth of a reference chain may not exceed 1.

pvcobject

DataVolumeSourcePVC provides the parameters to create a Data Volume from an existing PVC

snapshotobject

DataVolumeSourceSnapshot provides the parameters to create a Data Volume from an existing VolumeSnapshot

.status.source.dataSource

Description
DataSourceRefSourceDataSource serves as a reference to another DataSource Can be resolved into a DataVolumeSourcePVC or a DataVolumeSourceSnapshot The maximum depth of a reference chain may not exceed 1.
Type
object
Required
namenamespace
PropertyTypeDescription
namestring

The name of the source DataSource

namespacestring

The namespace of the source DataSource

.status.source.pvc

Description
DataVolumeSourcePVC provides the parameters to create a Data Volume from an existing PVC
Type
object
Required
namenamespace
PropertyTypeDescription
namestring

The name of the source PVC

namespacestring

The namespace of the source PVC

.status.source.snapshot

Description
DataVolumeSourceSnapshot provides the parameters to create a Data Volume from an existing VolumeSnapshot
Type
object
Required
namenamespace
PropertyTypeDescription
namestring

The name of the source VolumeSnapshot

namespacestring

The namespace of the source VolumeSnapshot

API Endpoints

The following API endpoints are available:

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

/apis/cdi.kubevirt.io/v1beta1/namespaces/{namespace}/datasources

HTTP method
DELETE
Description
delete collection of DataSource
HTTP responses
HTTP codeResponse body
200 - OKStatus schema
401 - UnauthorizedEmpty
HTTP method
GET
Description
list objects of kind DataSource
HTTP responses
HTTP codeResponse body
200 - OKDataSourceList schema
401 - UnauthorizedEmpty
HTTP method
POST
Description
create a new DataSource
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
bodyDataSource schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKDataSource schema
201 - CreatedDataSource schema
202 - AcceptedDataSource schema
401 - UnauthorizedEmpty

/apis/cdi.kubevirt.io/v1beta1/namespaces/{namespace}/datasources/{name}

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

/apis/cdi.kubevirt.io/v1beta1/namespaces/{namespace}/datasources/{name}/status

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