Skip to main content

Retrieve the backup status

Contributors

GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment/{workingEnvironmentId}/status

Retrieves the backup status of a specified working environment backed up by using BlueXP backup and recovery within an account. It retrieves backup enablement status, archive storage class, archive after days, catalog enablement status, auto enablement status, maximum transfer status, backup policy details, cloud storage pool, and remote MetroCluster ID.

Token usage: BlueXP user token.

Parameters

Name Type In Required Description

partial

boolean

query

False

accountId

string

path

True

workingEnvironmentId

string

path

True

authorization

string

header

True

x-agent-id

string

header

True

Response

Status: 200, Default response
Name Type Required Description

name

string

False

id

string

False

region

string

False

status

string

False

ontap-version

string

False

backup-enablement-status

string

False

type

string

False

provider

string

False

provider-account-id

string

False

provider-account-name

string

False

bucket

string

False

archive-storage-class

string

False

resource-group

string

False

storage-account

string

False

storage-server

string

False

used-capacity-gb

string

False

charging-capacity

string

False

logical-used-size

string

False

backed-up-volume-count

string

False

total-volumes-count

string

False

backup-policy-count

string

False

failed-backup-volume-count

string

False

catalog-enabled

boolean

False

auto-backup-enabled

boolean

False

backup-policy

backup-policy

False

private-endpoint-required

boolean

False

license

license

False

ip-space

string

False

provider-access-key

string

False

delete-yearly-snapshots

boolean

False

export-existing-snapshots

boolean

False
Example response 
{
  "name": "string",
  "id": "string",
  "region": "string",
  "status": "string",
  "ontap-version": "string",
  "backup-enablement-status": "string",
  "type": "string",
  "provider": "string",
  "provider-account-id": "string",
  "provider-account-name": "string",
  "bucket": "string",
  "archive-storage-class": "string",
  "resource-group": "string",
  "storage-account": "string",
  "storage-server": "string",
  "used-capacity-gb": "string",
  "charging-capacity": "string",
  "logical-used-size": "string",
  "backed-up-volume-count": "string",
  "total-volumes-count": "string",
  "backup-policy-count": "string",
  "failed-backup-volume-count": "string",
  "backup-policy": {
    "name": "string",
    "rule": [
      {
        "label": "string",
        "retention": "string"
      }
    ],
    "archive-after-days": "string"
  },
  "ip-space": "string",
  "provider-access-key": "string"
}

Definitions

See Definitions

rule

Name Type Required Description

label

string

False

retention

string

False

backup-policy

Name Type Required Description

name

string

False

rule

array[rule]

False

archive-after-days

string

False

license

Name Type Required Description

free-trial-end

number

False

eligible

boolean

False