Schedule Resource Service Create
Create a Schedule.
Request
URI
POST
https://{api_host}/https://your_org.tmc.cloud.vmware.com/v1alpha1/clustergroups/{schedule.fullName.clusterGroupName}/dataprotection/schedules
COPY
Path Parameters
string
schedule.fullName.clusterGroupName
Required
Name of Cluster group.
Request Body
vmware.tanzu.manage.v1alpha1.clustergroup.dataprotection.schedule.CreateScheduleRequest of type(s) application/json
Required
{
"schedule": {
"type": {
"kind": "string",
"version": "string",
"package": "string"
},
"fullName": {
"orgId": "string",
"clusterGroupName": "string",
"name": "string"
},
"meta": {
"uid": "string",
"generation": "string",
"resourceVersion": "string",
"creationTime": "string",
"updateTime": "string",
"description": "string",
"parentReferences": [
{
"rid": "string",
"uid": "string"
}
]
},
"spec": {
"atomicSpec": {
"template": {
"includedNamespaces": [
"string"
],
"excludedNamespaces": [
"string"
],
"includedResources": [
"string"
],
"excludedResources": [
"string"
],
"labelSelector": {
"matchExpressions": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
]
},
"snapshotVolumes": false,
"ttl": "string",
"includeClusterResources": false,
"storageLocation": "string",
"volumeSnapshotLocations": [
"string"
],
"orLabelSelectors": [
{
"matchExpressions": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
]
}
],
"defaultVolumesToRestic": false,
"csiSnapshotTimeout": "string",
"defaultVolumesToFsBackup": false,
"hooks": {
"resources": [
{
"name": "string",
"includedNamespaces": [
"string"
],
"excludedNamespaces": [
"string"
],
"labelSelector": {
"matchExpressions": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
]
},
"preHooks": [
{
"exec": {
"container": "string",
"command": [
"string"
],
"onError": "string",
"timeout": "string"
}
}
],
"postHooks": [
{
"exec": {
"container": "string",
"command": [
"string"
],
"onError": "string",
"timeout": "string"
}
}
]
}
]
},
"includedClusterScopedResources": [
"string"
],
"excludedClusterScopedResources": [
"string"
],
"includedNamespaceScopedResources": [
"string"
],
"excludedNamespaceScopedResources": [
"string"
],
"snapshotMoveData": false
},
"schedule": {
"rate": "string"
},
"paused": false
},
"selector": {
"names": [
"string"
],
"excludedNames": [
"string"
],
"labelSelector": {
"matchExpressions": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
]
}
}
},
"status": {
"phase": "string",
"details": {
"availableTargets": 0,
"applied": 0,
"overridden": 0,
"pending": 0,
"error": 0,
"deleting": 0,
"skipped": 0
},
"observedGeneration": "string"
}
}
}
Responses
200
A successful response.
Returns vmware.tanzu.manage.v1alpha1.clustergroup.dataprotection.schedule.CreateScheduleResponse of type(s) */*
{
"schedule": {
"type": {
"kind": "string",
"version": "string",
"package": "string"
},
"fullName": {
"orgId": "string",
"clusterGroupName": "string",
"name": "string"
},
"meta": {
"uid": "string",
"generation": "string",
"resourceVersion": "string",
"creationTime": "string",
"updateTime": "string",
"description": "string",
"parentReferences": [
{
"rid": "string",
"uid": "string"
}
]
},
"spec": {
"atomicSpec": {
"template": {
"includedNamespaces": [
"string"
],
"excludedNamespaces": [
"string"
],
"includedResources": [
"string"
],
"excludedResources": [
"string"
],
"labelSelector": {
"matchExpressions": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
]
},
"snapshotVolumes": false,
"ttl": "string",
"includeClusterResources": false,
"storageLocation": "string",
"volumeSnapshotLocations": [
"string"
],
"orLabelSelectors": [
{
"matchExpressions": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
]
}
],
"defaultVolumesToRestic": false,
"csiSnapshotTimeout": "string",
"defaultVolumesToFsBackup": false,
"hooks": {
"resources": [
{
"name": "string",
"includedNamespaces": [
"string"
],
"excludedNamespaces": [
"string"
],
"labelSelector": {
"matchExpressions": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
]
},
"preHooks": [
{
"exec": {
"container": "string",
"command": [
"string"
],
"onError": "string",
"timeout": "string"
}
}
],
"postHooks": [
{
"exec": {
"container": "string",
"command": [
"string"
],
"onError": "string",
"timeout": "string"
}
}
]
}
]
},
"includedClusterScopedResources": [
"string"
],
"excludedClusterScopedResources": [
"string"
],
"includedNamespaceScopedResources": [
"string"
],
"excludedNamespaceScopedResources": [
"string"
],
"snapshotMoveData": false
},
"schedule": {
"rate": "string"
},
"paused": false
},
"selector": {
"names": [
"string"
],
"excludedNames": [
"string"
],
"labelSelector": {
"matchExpressions": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
]
}
}
},
"status": {
"phase": "string",
"details": {
"availableTargets": 0,
"applied": 0,
"overridden": 0,
"pending": 0,
"error": 0,
"deleting": 0,
"skipped": 0
},
"observedGeneration": "string"
}
}
}
default
An unexpected error response.
Returns grpc.gateway.runtime.Error of type(s) */*
{
"error": "string",
"code": 0,
"message": "string",
"details": [
{
"typeUrl": "string",
"value": "string"
}
]
}
Schedule Resource Service Operations
POST
Schedule Resource Service Create
POST
Schedule Resource Service Create
POST
Schedule Resource Service Create
DELETE
Schedule Resource Service Delete
DELETE
Schedule Resource Service Delete
DELETE
Schedule Resource Service Delete
GET
Schedule Resource Service Get
GET
Schedule Resource Service Get
GET
Schedule Resource Service Get
GET
Schedule Resource Service List
GET
Schedule Resource Service List
GET
Schedule Resource Service List
PUT
Schedule Resource Service Update
PUT
Schedule Resource Service Update