Patch a Virtual Machine Backup
PATCH/apis/harvesterhci.io/v1beta1/namespaces/{namespace:[a-z0-9][a-z0-9\-]*}/virtualmachinebackups/{name:[a-z0-9][a-z0-9\-]*}
Patch a VirtualMachineBackup object.
Request
Path Parameters
name stringrequired
Name of the resource
namespace stringrequired
Object name and auth scope, such as for teams and projects
- application/json-patch+json
- application/merge-patch+json
Body
required
object
Body
required
object
Responses
- 200
- 401
OK
- application/json
- Schema
- Example (from schema)
Schema
apiVersion stringrequired
kind stringrequired
metadata object
spec objectrequired
status object
{
"apiVersion": "string",
"kind": "string",
"metadata": {
"name": "string",
"namespace": "string"
},
"spec": {
"source": {
"apiGroup": "string",
"kind": "string",
"name": "string"
},
"type": "string"
},
"status": {
"backupTarget": {
"bucketName": "string",
"bucketRegion": "string",
"endpoint": "string"
},
"conditions": [
{
"lastTransitionTime": "string",
"lastUpdateTime": "string",
"message": "string",
"reason": "string",
"status": "string",
"type": "string"
}
],
"creationTime": "string",
"csiDriverVolumeSnapshotClassNames": {},
"error": {
"message": "string",
"time": "string"
},
"readyToUse": true,
"secretBackups": [
{
"data": {},
"name": "string"
}
],
"source": {
"metadata": {
"name": "string",
"namespace": "string"
},
"spec": {
"dataVolumeTemplates": [
{
"apiVersion": "string",
"kind": "string",
"metadata": {
"name": "string",
"namespace": "string"
},
"spec": {
"checkpoints": [
{
"current": "string",
"previous": "string"
}
],
"contentType": "string",
"finalCheckpoint": true,
"preallocation": true,
"priorityClassName": "string",
"pvc": {
"accessModes": [
"string"
],
"dataSource": {
"apiGroup": "string",
"kind": "string",
"name": "string"
},
"dataSourceRef": {
"apiGroup": "string",
"kind": "string",
"name": "string"
},
"resources": {
"limits": {},
"requests": {}
},
"selector": {
"matchExpressions": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
],
"matchLabels": {}
},
"storageClassName": "string",
"volumeMode": "string",
"volumeName": "string"
},
"source": {
"blank": {},
"http": {
"certConfigMap": "string",
"extraHeaders": [
"string"
],
"secretExtraHeaders": [
"string"
],
"secretRef": "string",
"url": "string"
},
"imageio": {
"certConfigMap": "string",
"diskId": "string",
"secretRef": "string",
"url": "string"
},
"pvc": {
"name": "string",
"namespace": "string"
},
"registry": {
"certConfigMap": "string",
"imageStream": "string",
"pullMethod": "string",
"secretRef": "string",
"url": "string"
},
"s3": {
"certConfigMap": "string",
"secretRef": "string",
"url": "string"
},
"upload": {},
"vddk": {
"backingFile": "string",
"initImageURL": "string",
"secretRef": "string",
"thumbprint": "string",
"url": "string",
"uuid": "string"
}
},
"sourceRef": {
"kind": "string",
"name": "string",
"namespace": "string"
},
"storage": {
"accessModes": [
"string"
],
"dataSource": {
"apiGroup": "string",
"kind": "string",
"name": "string"
},
"resources": {
"limits": {},
"requests": {}
},
"selector": {
"matchExpressions": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
],
"matchLabels": {}
},
"storageClassName": "string",
"volumeMode": "string",
"volumeName": "string"
}
},
"status": {}
}
],
"flavor": {
"kind": "string",
"name": "string"
},
"preference": {
"kind": "string",
"name": "string"
},
"runStrategy": "string",
"running": true,
"template": {
"metadata": {
"name": "string",
"namespace": "string"
},
"spec": {
"accessCredentials": [
{
"sshPublicKey": {
"propagationMethod": {
"configDrive": {},
"qemuGuestAgent": {
"users": [
"string"
]
}
},
"source": {
"secret": {
"secretName": "string"
}
}
},
"userPassword": {
"propagationMethod": {
"qemuGuestAgent": {}
},
"source": {
"secret": {
"secretName": "string"
}
}
}
}
],
"affinity": {
"nodeAffinity": {
"preferredDuringSchedulingIgnoredDuringExecution": [
{
"preference": {
"matchExpressions": [
{
"key": "string",
"operator": "DoesNotExist",
"values": [
"string"
]
}
],
"matchFields": [
{
"key": "string",
"operator": "DoesNotExist",
"values": [
"string"
]
}
]
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": {
"nodeSelectorTerms": [
{
"matchExpressions": [
{
"key": "string",
"operator": "DoesNotExist",
"values": [
"string"
]
}
],
"matchFields": [
{
"key": "string",
"operator": "DoesNotExist",
"values": [
"string"
]
}
]
}
]
}
},
"podAffinity": {
"preferredDuringSchedulingIgnoredDuringExecution": [
{
"podAffinityTerm": {
"labelSelector": {
"matchExpressions": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
],
"matchLabels": {}
},
"namespaceSelector": {
"matchExpressions": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
],
"matchLabels": {}
},
"namespaces": [
"string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [
{
"labelSelector": {
"matchExpressions": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
],
"matchLabels": {}
},
"namespaceSelector": {
"matchExpressions": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
],
"matchLabels": {}
},
"namespaces": [
"string"
],
"topologyKey": "string"
}
]
},
"podAntiAffinity": {
"preferredDuringSchedulingIgnoredDuringExecution": [
{
"podAffinityTerm": {
"labelSelector": {
"matchExpressions": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
],
"matchLabels": {}
},
"namespaceSelector": {
"matchExpressions": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
],
"matchLabels": {}
},
"namespaces": [
"string"
],
"topologyKey": "string"
},
"weight": 0
}
],
"requiredDuringSchedulingIgnoredDuringExecution": [
{
"labelSelector": {
"matchExpressions": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
],
"matchLabels": {}
},
"namespaceSelector": {
"matchExpressions": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
],
"matchLabels": {}
},
"namespaces": [
"string"
],
"topologyKey": "string"
}
]
}
},
"dnsConfig": {
"nameservers": [
"string"
],
"options": [
{
"name": "string",
"value": "string"
}
],
"searches": [
"string"
]
},
"dnsPolicy": "ClusterFirst",
"domain": {
"chassis": {
"asset": "string",
"manufacturer": "string",
"serial": "string",
"sku": "string",
"version": "string"
},
"clock": {
"timer": {
"hpet": {
"present": true,
"tickPolicy": "string"
},
"hyperv": {
"present": true
},
"kvm": {
"present": true
},
"pit": {
"present": true,
"tickPolicy": "string"
},
"rtc": {
"present": true,
"tickPolicy": "string",
"track": "string"
}
},
"timezone": "string",
"utc": {
"offsetSeconds": 0
}
},
"cpu": {
"cores": 0,
"dedicatedCpuPlacement": true,
"features": [
{
"name": "string",
"policy": "string"
}
],
"isolateEmulatorThread": true,
"model": "string",
"numa": {
"guestMappingPassthrough": {}
},
"realtime": {
"mask": "string"
},
"sockets": 0,
"threads": 0
},
"devices": {
"autoattachGraphicsDevice": true,
"autoattachMemBalloon": true,
"autoattachPodInterface": true,
"autoattachSerialConsole": true,
"blockMultiQueue": true,
"clientPassthrough": {},
"disableHotplug": true,
"disks": [
{
"blockSize": {
"custom": {
"logical": 0,
"physical": 0
},
"matchVolume": {
"enabled": true
}
},
"bootOrder": 0,
"cache": "string",
"cdrom": {
"bus": "string",
"readonly": true,
"tray": "string"
},
"dedicatedIOThread": true,
"disk": {
"bus": "string",
"pciAddress": "string",
"readonly": true
},
"io": "string",
"lun": {
"bus": "string",
"readonly": true
},
"name": "string",
"serial": "string",
"shareable": true,
"tag": "string"
}
],
"filesystems": [
{
"name": "string",
"virtiofs": {}
}
],
"gpus": [
{
"deviceName": "string",
"name": "string",
"tag": "string",
"virtualGPUOptions": {
"display": {
"enabled": true,
"ramFB": {
"enabled": true
}
}
}
}
],
"hostDevices": [
{
"deviceName": "string",
"name": "string",
"tag": "string"
}
],
"inputs": [
{
"bus": "string",
"name": "string",
"type": "string"
}
],
"interfaces": [
{
"bootOrder": 0,
"bridge": {},
"dhcpOptions": {
"bootFileName": "string",
"ntpServers": [
"string"
],
"privateOptions": [
{
"option": 0,
"value": "string"
}
],
"tftpServerName": "string"
},
"macAddress": "string",
"macvtap": {},
"masquerade": {},
"model": "string",
"name": "string",
"pciAddress": "string",
"ports": [
{
"name": "string",
"port": 0,
"protocol": "string"
}
],
"slirp": {},
"sriov": {},
"tag": "string"
}
],
"networkInterfaceMultiqueue": true,
"rng": {},
"sound": {
"model": "string",
"name": "string"
},
"tpm": {},
"useVirtioTransitional": true,
"watchdog": {
"i6300esb": {
"action": "string"
},
"name": "string"
}
},
"features": {
"acpi": {
"enabled": true
},
"apic": {
"enabled": true,
"endOfInterrupt": true
},
"hyperv": {
"evmcs": {
"enabled": true
},
"frequencies": {
"enabled": true
},
"ipi": {
"enabled": true
},
"reenlightenment": {
"enabled": true
},
"relaxed": {
"enabled": true
},
"reset": {
"enabled": true
},
"runtime": {
"enabled": true
},
"spinlocks": {
"enabled": true,
"spinlocks": 0
},
"synic": {
"enabled": true
},
"synictimer": {
"direct": {
"enabled": true
},
"enabled": true
},
"tlbflush": {
"enabled": true
},
"vapic": {
"enabled": true
},
"vendorid": {
"enabled": true,
"vendorid": "string"
},
"vpindex": {
"enabled": true
}
},
"kvm": {
"hidden": true
},
"pvspinlock": {
"enabled": true
},
"smm": {
"enabled": true
}
},
"firmware": {
"bootloader": {
"bios": {
"useSerial": true
},
"efi": {
"secureBoot": true
}
},
"kernelBoot": {
"container": {
"image": "string",
"imagePullPolicy": "Always",
"imagePullSecret": "string",
"initrdPath": "string",
"kernelPath": "string"
},
"kernelArgs": "string"
},
"serial": "string",
"uuid": "string"
},
"ioThreadsPolicy": "string",
"launchSecurity": {
"sev": {}
},
"machine": {
"type": "string"
},
"memory": {
"guest": "string",
"hugepages": {
"pageSize": "string"
}
},
"resources": {
"limits": {},
"overcommitGuestOverhead": true,
"requests": {}
}
},
"evictionStrategy": "string",
"hostname": "string",
"livenessProbe": {
"exec": {
"command": [
"string"
]
},
"failureThreshold": 0,
"guestAgentPing": {},
"httpGet": {
"host": "string",
"httpHeaders": [
{
"name": "string",
"value": "string"
}
],
"path": "string",
"port": {},
"scheme": "HTTP"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {
"host": "string",
"port": {}
},
"timeoutSeconds": 0
},
"networks": [
{
"multus": {
"default": true,
"networkName": "string"
},
"name": "string",
"pod": {
"vmIPv6NetworkCIDR": "string",
"vmNetworkCIDR": "string"
}
}
],
"nodeSelector": {},
"priorityClassName": "string",
"readinessProbe": {
"exec": {
"command": [
"string"
]
},
"failureThreshold": 0,
"guestAgentPing": {},
"httpGet": {
"host": "string",
"httpHeaders": [
{
"name": "string",
"value": "string"
}
],
"path": "string",
"port": {},
"scheme": "HTTP"
},
"initialDelaySeconds": 0,
"periodSeconds": 0,
"successThreshold": 0,
"tcpSocket": {
"host": "string",
"port": {}
},
"timeoutSeconds": 0
},
"schedulerName": "string",
"startStrategy": "string",
"subdomain": "string",
"terminationGracePeriodSeconds": 0,
"tolerations": [
{
"effect": "NoExecute",
"key": "string",
"operator": "Equal",
"tolerationSeconds": 0,
"value": "string"
}
],
"volumes": [
{
"cloudInitConfigDrive": {
"networkData": "string",
"networkDataBase64": "string",
"networkDataSecretRef": {
"name": "string"
},
"secretRef": {
"name": "string"
},
"userData": "string",
"userDataBase64": "string"
},
"cloudInitNoCloud": {
"networkData": "string",
"networkDataBase64": "string",
"networkDataSecretRef": {
"name": "string"
},
"secretRef": {
"name": "string"
},
"userData": "string",
"userDataBase64": "string"
},
"configMap": {
"name": "string",
"optional": true,
"volumeLabel": "string"
},
"containerDisk": {
"image": "string",
"imagePullPolicy": "Always",
"imagePullSecret": "string",
"path": "string"
},
"dataVolume": {
"hotpluggable": true,
"name": "string"
},
"downwardAPI": {
"fields": [
{
"fieldRef": {
"apiVersion": "string",
"fieldPath": "string"
},
"mode": 0,
"path": "string",
"resourceFieldRef": {
"containerName": "string",
"divisor": {},
"resource": "string"
}
}
],
"volumeLabel": "string"
},
"downwardMetrics": {},
"emptyDisk": {
"capacity": {}
},
"ephemeral": {
"persistentVolumeClaim": {
"claimName": "string",
"readOnly": true
}
},
"hostDisk": {
"capacity": {},
"path": "string",
"shared": true,
"type": "string"
},
"memoryDump": {
"claimName": "string",
"hotpluggable": true,
"readOnly": true
},
"name": "string",
"persistentVolumeClaim": {
"claimName": "string",
"hotpluggable": true,
"readOnly": true
},
"secret": {
"optional": true,
"secretName": "string",
"volumeLabel": "string"
},
"serviceAccount": {
"serviceAccountName": "string"
},
"sysprep": {
"configMap": {
"name": "string"
},
"secret": {
"name": "string"
}
}
}
]
}
}
}
},
"sourceUID": "string",
"volumeBackups": [
{
"creationTime": "string",
"csiDriverName": "string",
"error": {
"message": "string",
"time": "string"
},
"longhornBackupName": "string",
"name": "string",
"persistentVolumeClaim": {
"metadata": {
"name": "string",
"namespace": "string"
},
"spec": {
"accessModes": [
"string"
],
"dataSource": {
"apiGroup": "string",
"kind": "string",
"name": "string"
},
"dataSourceRef": {
"apiGroup": "string",
"kind": "string",
"name": "string"
},
"resources": {
"limits": {},
"requests": {}
},
"selector": {
"matchExpressions": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
],
"matchLabels": {}
},
"storageClassName": "string",
"volumeMode": "string",
"volumeName": "string"
}
},
"readyToUse": true,
"volumeName": "string"
}
]
}
}
Unauthorized
- application/json
- Schema
Schema
string
- curl
- python
- go
- nodejs
- CURL
curl -L -X GET 'https://docs.harvesterhci.io' \
-H 'Content-Type: application/json-patch+json' \
-H 'Accept: application/json'