Schedule Resource Service Update

Schedule Resource Service Update

Update (overwrite) a Schedule.

Request
URI
PUT
https://{api_host}/https://your_org.tmc.cloud.vmware.com/v1alpha1/clustergroups/{schedule.fullName.clusterGroupName}/dataprotection/schedules/{schedule.fullName.name}
COPY
Path Parameters
string
schedule.fullName.clusterGroupName
Required

Name of Cluster group.

string
schedule.fullName.name
Required

Name of this Schedule.


Request Body
{
    "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.

{
    "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"
        }
    ]
}