Returns the cluster backup result

GET 
/v1/spectroclusters/:uid/features/backup

Returns the cluster backup result

Request

Path Parameters

uid stringrequired

Query Parameters

backupRequestUid string

Header Parameters

ProjectUid string

Scope the request to the specified project uid

Responses

200

OK

application/json

Schema

Schema

metadata

object

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

annotations

object

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

property name*string

creationTimestampdate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

deletionTimestampdate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

labels

object

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels

property name*string

lastModifiedTimestampdate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

namestring

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names

uidstring

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

spec

Cluster Backup Spec

clusterUidstring

config

Cluster backup config

backupLocationNamestring

backupLocationUidstring

backupNamestring

backupPrefixstring

durationInHoursint64

includeAllDisksboolean

includeClusterResourcesboolean

locationTypestring

namespacesstring[]

schedule

Cluster feature schedule

scheduledRunTimestring

status

Cluster Backup Status

clusterBackupStatuses

undefined[]

Array [

actor

Compliance Scan actor

actorTypestring

uidstring

backupConfig

Backup config

includeAllDisksboolean

includeClusterResourcesboolean

namespacesstring[]

backupLocationConfig

Backup location configuration

namestring

typestring

uidstring

backupRequestUidstring

backupStatusMeta

undefined[]

Array [

backupNamestring

backupState

Backup state

backupTimedate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

deleteStatestring

msgstring

statestring

backupedNamespacesstring[]

expiryDatedate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

]

restoreStatusMeta

undefined[]

Array [

backupNamestring

destinationClusterRef

object

kindstring

namestring

uidstringrequired

restoreStatestring

]

statestring

]

Example (from schema)

{
  "metadata": {
    "annotations": {},
    "creationTimestamp": "2024-07-26T20:10:11.121Z",
    "deletionTimestamp": "2024-07-26T20:10:11.121Z",
    "labels": {},
    "lastModifiedTimestamp": "2024-07-26T20:10:11.121Z",
    "name": "string",
    "uid": "string"
  },
  "spec": {
    "clusterUid": "string",
    "config": {
      "backupLocationName": "string",
      "backupLocationUid": "string",
      "backupName": "string",
      "backupPrefix": "string",
      "durationInHours": 0,
      "includeAllDisks": true,
      "includeClusterResources": true,
      "locationType": "string",
      "namespaces": [
        "string"
      ],
      "schedule": {
        "scheduledRunTime": "string"
      }
    }
  },
  "status": {
    "clusterBackupStatuses": [
      {
        "actor": {
          "actorType": "string",
          "uid": "string"
        },
        "backupConfig": {
          "includeAllDisks": true,
          "includeClusterResources": true,
          "namespaces": [
            "string"
          ]
        },
        "backupLocationConfig": {
          "name": "string",
          "type": "string",
          "uid": "string"
        },
        "backupRequestUid": "string",
        "backupStatusMeta": [
          {
            "backupName": "string",
            "backupState": {
              "backupTime": "2024-07-26T20:10:11.121Z",
              "deleteState": "string",
              "msg": "string",
              "state": "string"
            },
            "backupedNamespaces": [
              "string"
            ],
            "expiryDate": "2024-07-26T20:10:11.121Z"
          }
        ],
        "restoreStatusMeta": [
          {
            "backupName": "string",
            "destinationClusterRef": {
              "kind": "string",
              "name": "string",
              "uid": "string"
            },
            "restoreState": "string"
          }
        ],
        "state": "string"
      }
    ]
  }
}

Loading...