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 are system generated key value metadata for the resource. As an input certain annotations like description can be set

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

Labels are key value data to organize and categorize resources. Providing spectro__tag as value for a label is considered as a kubernetes compliant tag

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 of the resource

uidstring

UID is the unique identifier generated for the resource. This is not an input field for any request.

Populated by the system. Read-only.

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": "2023-12-01T21:31:48.922Z",
    "deletionTimestamp": "2023-12-01T21:31:48.922Z",
    "labels": {},
    "lastModifiedTimestamp": "2023-12-01T21:31:48.922Z",
    "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": "2023-12-01T21:31:48.922Z",
              "deleteState": "string",
              "msg": "string",
              "state": "string"
            },
            "backupedNamespaces": [
              "string"
            ],
            "expiryDate": "2023-12-01T21:31:48.922Z"
          }
        ],
        "restoreStatusMeta": [
          {
            "backupName": "string",
            "destinationClusterRef": {
              "kind": "string",
              "name": "string",
              "uid": "string"
            },
            "restoreState": "string"
          }
        ],
        "state": "string"
      }
    ]
  }
}

Loading...