Restore Resource Service Create

Restore Resource Service Create

Create a Restore.

Request
URI
POST
https://{api_host}/https://your_org.tmc.cloud.vmware.com/v1alpha1/clusters/{restore.fullName.clusterName}/dataprotection/restores
COPY
Path Parameters
string
restore.fullName.clusterName
Required

Name of Cluster.


Request Body
{
    "restore": {
        "type": {
            "kind": "string",
            "version": "string",
            "package": "string"
        },
        "fullName": {
            "orgId": "string",
            "managementClusterName": "string",
            "provisionerName": "string",
            "clusterName": "string",
            "name": "string"
        },
        "meta": {
            "uid": "string",
            "generation": "string",
            "resourceVersion": "string",
            "creationTime": "string",
            "updateTime": "string",
            "description": "string",
            "parentReferences": [
                {
                    "rid": "string",
                    "uid": "string"
                }
            ]
        },
        "spec": {
            "backupName": "string",
            "scheduleName": "string",
            "includedNamespaces": [
                "string"
            ],
            "excludedNamespaces": [
                "string"
            ],
            "includedResources": [
                "string"
            ],
            "excludedResources": [
                "string"
            ],
            "labelSelector": {
                "matchExpressions": [
                    {
                        "key": "string",
                        "operator": "string",
                        "values": [
                            "string"
                        ]
                    }
                ]
            },
            "restorePvs": false,
            "includeClusterResources": false,
            "backupRef": {
                "cluster": {
                    "orgId": "string",
                    "managementClusterName": "string",
                    "provisionerName": "string",
                    "name": "string"
                },
                "backupName": "string",
                "backupUid": "string"
            },
            "orLabelSelectors": [
                {
                    "matchExpressions": [
                        {
                            "key": "string",
                            "operator": "string",
                            "values": [
                                "string"
                            ]
                        }
                    ]
                }
            ],
            "restoreStatus": {
                "includedResources": [
                    "string"
                ],
                "excludedResources": [
                    "string"
                ]
            },
            "preserveNodePorts": false,
            "existingResourcePolicy": "string",
            "hooks": {
                "resources": [
                    {
                        "name": "string",
                        "includedNamespaces": [
                            "string"
                        ],
                        "excludedNamespaces": [
                            "string"
                        ],
                        "labelSelector": {
                            "matchExpressions": [
                                {
                                    "key": "string",
                                    "operator": "string",
                                    "values": [
                                        "string"
                                    ]
                                }
                            ]
                        },
                        "postHooks": [
                            {
                                "exec": {
                                    "container": "string",
                                    "command": [
                                        "string"
                                    ],
                                    "onError": "string",
                                    "execTimeout": "string",
                                    "waitTimeout": "string"
                                },
                                "init": {
                                    "initContainers": [
                                        {
                                            "raw": "string"
                                        }
                                    ],
                                    "timeout": "string"
                                }
                            }
                        ]
                    }
                ]
            }
        },
        "status": {
            "observedGeneration": "string",
            "phase": "string",
            "phaseInfo": "string",
            "availablePhases": [
                "string"
            ],
            "validationErrors": [
                "string"
            ],
            "warnings": 0,
            "errors": 0,
            "failureReason": "string",
            "completionTime": "string",
            "progress": {
                "totalItems": 0,
                "itemsRestored": 0
            },
            "restoreLogsUrl": "string",
            "restoreResultsUrl": "string",
            "gatherRestoreResourcesStatus": {},
            "volumeRestores": [
                {
                    "pvcName": "string",
                    "pvcNamespace": "string",
                    "pvName": "string",
                    "scName": "string",
                    "size": "string",
                    "method": "string",
                    "podInfo": {
                        "podName": "string",
                        "podNamespace": "string",
                        "podVolumeName": "string",
                        "restorePhase": "string"
                    }
                }
            ]
        }
    }
}
Responses
200

A successful response.

{
    "restore": {
        "type": {
            "kind": "string",
            "version": "string",
            "package": "string"
        },
        "fullName": {
            "orgId": "string",
            "managementClusterName": "string",
            "provisionerName": "string",
            "clusterName": "string",
            "name": "string"
        },
        "meta": {
            "uid": "string",
            "generation": "string",
            "resourceVersion": "string",
            "creationTime": "string",
            "updateTime": "string",
            "description": "string",
            "parentReferences": [
                {
                    "rid": "string",
                    "uid": "string"
                }
            ]
        },
        "spec": {
            "backupName": "string",
            "scheduleName": "string",
            "includedNamespaces": [
                "string"
            ],
            "excludedNamespaces": [
                "string"
            ],
            "includedResources": [
                "string"
            ],
            "excludedResources": [
                "string"
            ],
            "labelSelector": {
                "matchExpressions": [
                    {
                        "key": "string",
                        "operator": "string",
                        "values": [
                            "string"
                        ]
                    }
                ]
            },
            "restorePvs": false,
            "includeClusterResources": false,
            "backupRef": {
                "cluster": {
                    "orgId": "string",
                    "managementClusterName": "string",
                    "provisionerName": "string",
                    "name": "string"
                },
                "backupName": "string",
                "backupUid": "string"
            },
            "orLabelSelectors": [
                {
                    "matchExpressions": [
                        {
                            "key": "string",
                            "operator": "string",
                            "values": [
                                "string"
                            ]
                        }
                    ]
                }
            ],
            "restoreStatus": {
                "includedResources": [
                    "string"
                ],
                "excludedResources": [
                    "string"
                ]
            },
            "preserveNodePorts": false,
            "existingResourcePolicy": "string",
            "hooks": {
                "resources": [
                    {
                        "name": "string",
                        "includedNamespaces": [
                            "string"
                        ],
                        "excludedNamespaces": [
                            "string"
                        ],
                        "labelSelector": {
                            "matchExpressions": [
                                {
                                    "key": "string",
                                    "operator": "string",
                                    "values": [
                                        "string"
                                    ]
                                }
                            ]
                        },
                        "postHooks": [
                            {
                                "exec": {
                                    "container": "string",
                                    "command": [
                                        "string"
                                    ],
                                    "onError": "string",
                                    "execTimeout": "string",
                                    "waitTimeout": "string"
                                },
                                "init": {
                                    "initContainers": [
                                        {
                                            "raw": "string"
                                        }
                                    ],
                                    "timeout": "string"
                                }
                            }
                        ]
                    }
                ]
            }
        },
        "status": {
            "observedGeneration": "string",
            "phase": "string",
            "phaseInfo": "string",
            "availablePhases": [
                "string"
            ],
            "validationErrors": [
                "string"
            ],
            "warnings": 0,
            "errors": 0,
            "failureReason": "string",
            "completionTime": "string",
            "progress": {
                "totalItems": 0,
                "itemsRestored": 0
            },
            "restoreLogsUrl": "string",
            "restoreResultsUrl": "string",
            "gatherRestoreResourcesStatus": {},
            "volumeRestores": [
                {
                    "pvcName": "string",
                    "pvcNamespace": "string",
                    "pvName": "string",
                    "scName": "string",
                    "size": "string",
                    "method": "string",
                    "podInfo": {
                        "podName": "string",
                        "podNamespace": "string",
                        "podVolumeName": "string",
                        "restorePhase": "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"
        }
    ]
}