Alauda Container Platform

简体中文

DataDownload [velero.io/v2alpha1]

描述: DataDownload acts as the protocol between data mover plugins and data mover controller for the datamover restore operation
类型: object

规格

属性	类型	描述
`apiVersion`	`string`	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
`kind`	`string`	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
`metadata`	`ObjectMeta`	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
`spec`	`object`	DataDownloadSpec is the specification for a DataDownload.
`status`	`object`	DataDownloadStatus is the current status of a DataDownload.

.spec

描述: DataDownloadSpec is the specification for a DataDownload.
类型: object
必填: backupStorageLocationoperationTimeoutsnapshotIDsourceNamespacetargetVolume

属性	类型	描述
`backupStorageLocation`	`string`	BackupStorageLocation is the name of the backup storage location where the backup repository is stored.
`cancel`	`boolean`	Cancel indicates request to cancel the ongoing DataDownload. It can be set when the DataDownload is in InProgress phase
`dataMoverConfig`	`object`	DataMoverConfig is for data-mover-specific configuration fields.
`datamover`	`string`	DataMover specifies the data mover to be used by the backup. If DataMover is "" or "velero", the built-in data mover will be used.
`operationTimeout`	`string`	OperationTimeout specifies the time used to wait internal operations, before returning error as timeout.
`snapshotID`	`string`	SnapshotID is the ID of the Velero backup snapshot to be restored from.
`sourceNamespace`	`string`	SourceNamespace is the original namespace where the volume is backed up from. It may be different from SourcePVC's namespace if namespace is remapped during restore.
`targetVolume`	`object`	TargetVolume is the information of the target PVC and PV.

.spec.dataMoverConfig

描述: DataMoverConfig is for data-mover-specific configuration fields.
类型: object

.spec.targetVolume

描述: TargetVolume is the information of the target PVC and PV.
类型: object
必填: namespacepvpvc

属性	类型	描述
`namespace`	`string`	Namespace is the target namespace
`pv`	`string`	PV is the name of the target PV that is created by Velero restore
`pvc`	`string`	PVC is the name of the target PVC that is created by Velero restore

.status

描述: DataDownloadStatus is the current status of a DataDownload.
类型: object

属性	类型	描述
`completionTimestamp`	`string`	CompletionTimestamp records the time a restore was completed. Completion time is recorded even on failed restores. The server's time is used for CompletionTimestamps
`message`	`string`	Message is a message about the DataDownload's status.
`node`	`string`	Node is name of the node where the DataDownload is processed.
`phase`	`string`	Phase is the current state of the DataDownload.
`progress`	`object`	Progress holds the total number of bytes of the snapshot and the current number of restored bytes. This can be used to display progress information about the restore operation.
`startTimestamp`	`string`	StartTimestamp records the time a restore was started. The server's time is used for StartTimestamps

.status.progress

描述: Progress holds the total number of bytes of the snapshot and the current number of restored bytes. This can be used to display progress information about the restore operation.
类型: object

属性	类型	描述
`bytesDone`	`integer`
`totalBytes`	`integer`

API 端点

可用的 API 端点如下：

/apis/velero.io/v2alpha1/namespaces/{namespace}/datadownloads
- DELETE: delete collection of DataDownload
- GET: list objects of kind DataDownload
- POST: create a new DataDownload
/apis/velero.io/v2alpha1/namespaces/{namespace}/datadownloads/{name}
- DELETE: delete the specified DataDownload
- GET: read the specified DataDownload
- PATCH: partially update the specified DataDownload
- PUT: replace the specified DataDownload

/apis/velero.io/v2alpha1/namespaces/{namespace}/datadownloads

HTTP 方法: DELETE
描述: delete collection of DataDownload
HTTP 响应

HTTP 状态码	响应体
200 - OK	`Status` schema
401 - Unauthorized	Empty

HTTP 方法: GET
描述: list objects of kind DataDownload
HTTP 响应

HTTP 状态码	响应体
200 - OK	`DataDownloadList` schema
401 - Unauthorized	Empty

HTTP 方法: POST
描述: create a new DataDownload

查询参数

参数	类型	描述
`dryRun`	`string`	When 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
`fieldValidation`	`string`	fieldValidation 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`	`DataDownload` schema	`application/json` formatted

HTTP 响应

HTTP 状态码	响应体
200 - OK	`DataDownload` schema
201 - Created	`DataDownload` schema
202 - Accepted	`DataDownload` schema
401 - Unauthorized	Empty

/apis/velero.io/v2alpha1/namespaces/{namespace}/datadownloads/{name}

HTTP 方法: DELETE
描述: delete the specified DataDownload

查询参数

参数	类型	描述
`dryRun`	`string`	When 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 - OK	`Status` schema
202 - Accepted	`Status` schema
401 - Unauthorized	Empty

HTTP 方法: GET
描述: read the specified DataDownload
HTTP 响应

HTTP 状态码	响应体
200 - OK	`DataDownload` schema
401 - Unauthorized	Empty

HTTP 方法: PATCH
描述: partially update the specified DataDownload

查询参数

参数	类型	描述
`dryRun`	`string`	When 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
`fieldValidation`	`string`	fieldValidation 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 - OK	`DataDownload` schema
401 - Unauthorized	Empty

HTTP 方法: PUT
描述: replace the specified DataDownload

查询参数

参数	类型	描述
`dryRun`	`string`	When 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
`fieldValidation`	`string`	fieldValidation 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`	`DataDownload` schema	`application/json` formatted

HTTP 响应

HTTP 状态码	响应体
200 - OK	`DataDownload` schema
201 - Created	`DataDownload` schema
401 - Unauthorized	Empty