Update Kubernetes Cluster Protection

Update Kubernetes Cluster Protection

API code: UPDATE_KUBERNETES_CLUSTER_PROTECTION
Pre-authorized role(s): TENANT_USER | TENANT_ADMIN
Platform(s): AMAZON | OSIS | CLOUDIAN | ECS

Request
URI
PUT
https://apaas-29.eng.vmware.com//api/v1/k8s/clusters/{clusterId}/protection
COPY
Path Parameters
string
clusterId
Required

The ID of the protected Kubernetes cluster.


Request Body
ClusterProtection of type(s) application/json
Required
{
    "appName": "string",
    "appId": "string",
    "status": "string",
    "creationDate": "string",
    "backupStorageLocation": {
        "name": "string",
        "bucket": "string",
        "region": "string",
        "caCert": "string",
        "sseS3": false,
        "status": "string"
    },
    "volumeSnapshotLocation": {
        "name": "string",
        "provider": "string",
        "config": {
            "config": "string"
        }
    },
    "accessKey": "string",
    "storageUserId": "string",
    "schedule": {
        "metadata": {
            "name": "string",
            "namespace": "string",
            "resourceVersion": "string",
            "creationTimestamp": "string",
            "annotations": {
                "annotations": "string"
            },
            "labels": {
                "labels": "string"
            }
        },
        "spec": {
            "template": {
                "includedNamespaces": [
                    "string"
                ],
                "excludedNamespaces": [
                    "string"
                ],
                "includedResources": [
                    "string"
                ],
                "excludedResources": [
                    "string"
                ],
                "includeClusterResources": "string",
                "orderedResources": "string",
                "labelSelector": {
                    "labelSelector": "string"
                },
                "snapshotVolumes": false,
                "ttl": "string",
                "storageLocation": "string",
                "volumeSnapshotLocations": [
                    "string"
                ],
                "advancedOptions": {
                    "advancedOptions": "string"
                }
            },
            "schedule": "string"
        },
        "status": {
            "phase": "string",
            "lastBackup": "string",
            "validationErrors": [
                "string"
            ]
        }
    },
    "supportSnapshotVolume": false,
    "message": "string"
}
string
appName
Optional

appName

string
appId
Optional

appId

string
status
Optional

status

Possible values are : UNPROTECTED, PROTECTING, PROTECTED, FAILED, UNPROTECTING,
string As date-time As date-time
creationDate
Optional

creationDate

backupStorageLocation
Optional

backupStorageLocation

volumeSnapshotLocation
Optional

volumeSnapshotLocation

string
accessKey
Optional

accessKey

string
storageUserId
Optional

storageUserId

schedule
Optional

schedule

boolean
supportSnapshotVolume
Optional

supportSnapshotVolume

string
message
Optional

message

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns ClusterProtection of type(s) */*
{
    "appName": "string",
    "appId": "string",
    "status": "string",
    "creationDate": "string",
    "backupStorageLocation": {
        "name": "string",
        "bucket": "string",
        "region": "string",
        "caCert": "string",
        "sseS3": false,
        "status": "string"
    },
    "volumeSnapshotLocation": {
        "name": "string",
        "provider": "string",
        "config": {
            "config": "string"
        }
    },
    "accessKey": "string",
    "storageUserId": "string",
    "schedule": {
        "metadata": {
            "name": "string",
            "namespace": "string",
            "resourceVersion": "string",
            "creationTimestamp": "string",
            "annotations": {
                "annotations": "string"
            },
            "labels": {
                "labels": "string"
            }
        },
        "spec": {
            "template": {
                "includedNamespaces": [
                    "string"
                ],
                "excludedNamespaces": [
                    "string"
                ],
                "includedResources": [
                    "string"
                ],
                "excludedResources": [
                    "string"
                ],
                "includeClusterResources": "string",
                "orderedResources": "string",
                "labelSelector": {
                    "labelSelector": "string"
                },
                "snapshotVolumes": false,
                "ttl": "string",
                "storageLocation": "string",
                "volumeSnapshotLocations": [
                    "string"
                ],
                "advancedOptions": {
                    "advancedOptions": "string"
                }
            },
            "schedule": "string"
        },
        "status": {
            "phase": "string",
            "lastBackup": "string",
            "validationErrors": [
                "string"
            ]
        }
    },
    "supportSnapshotVolume": false,
    "message": "string"
}
string
appName
Optional

appName

string
appId
Optional

appId

string
status
Optional

status

Possible values are : UNPROTECTED, PROTECTING, PROTECTED, FAILED, UNPROTECTING,
string As date-time As date-time
creationDate
Optional

creationDate

backupStorageLocation
Optional

backupStorageLocation

volumeSnapshotLocation
Optional

volumeSnapshotLocation

string
accessKey
Optional

accessKey

string
storageUserId
Optional

storageUserId

schedule
Optional

schedule

boolean
supportSnapshotVolume
Optional

supportSnapshotVolume

string
message
Optional

message