Skip to main content

Retrieve volume details

Contributors

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

Retrieves details of all the volumes for a specified working environment backed up by using BlueXP backup and recovery. It retrieves the volume name, volume type, protocol, storage VM, backup status, last backup creation time, Snapshot copy count, associated backup policy, and backup policy rules. It also retrieves details of the archive after days, object lock, ransomware scan status, last ransomware scan, and ransomware detected Snapshot copies with last ransomware scan information.

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

volume

array[volume]

False
Example response 
{
  "volume": [
    {
      "file-system-id": "string",
      "name": "string",
      "type": "string",
      "style": "string",
      "protocol": "string",
      "svm": "string",
      "status": "string",
      "backup-status": "string",
      "snapshot-count": "string",
      "backup-policy": {
        "name": "string",
        "rule": [
          {
            "label": "string",
            "retention": "string"
          }
        ],
        "archive-after-days": "string"
      },
      "lag": "string",
      "capacity": {
        "allocated": "string",
        "used": "string",
        "charging": "string",
        "logicalUsedSize": "string"
      },
      "object-lock": "string",
      "ransomware-scan-status": "string",
      "ransomware-detected-snapshots": [
        {
          "snapshot-id": "string",
          "snapshot-name": "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

capacity

Name Type Required Description

allocated

string

False

used

string

False

charging

string

False

logicalUsedSize

string

False

ransomware-detected-snapshots

Name Type Required Description

snapshot-id

string

False

snapshot-name

string

False

last-ransomware-scan

number

False

volume

Name Type Required Description

file-system-id

string

False

name

string

False

type

string

False

style

string

False

protocol

string

False

svm

string

False

status

string

False

backup-status

string

False

last-backup-creation-time

number

False

snapshot-count

string

False

backup-policy

backup-policy

False

lag

string

False

capacity

capacity

False

object-lock

string

False

ransomware-scan-status

string

False

last-ransomware-scan

number

False

ransomware-detected-snapshots

array[ransomware-detected-snapshots]

False

geometry

number

False

aggregate-count

number

False