Skip to main content

Retrieve the volumes for backup activation

GET /vsa/volumes/volumes-for-backup

Retrieves all volumes for backup activation.

Parameters

Name Type In Required Description

workingEnvironmentId

string

query

False

offset

integer

query

False

limit

integer

query

False

search

string

query

False

filterBy

ListFilterByParam

query

False

sortBy

ListSortByParam

query

False

Error

Status: Default, Default response
Name Type Required Description

allowedValuesForVolumesListFilter

AllowedValuesForVolumesListFilter

False

filteredNumberOfVolumes

filteredNumberOfVolumes

False

hasNextPage

hasNextPage

False

totalNumberOfVolumes

integer

True

volumes

array[VolumeForBackupResponse]

True
Example error response 
{
  "allowedValuesForVolumesListFilter": {
    "diskTypes": [
      "string"
    ],
    "svmNames": [
      "string"
    ],
    "volumeStatus": [
      "string"
    ],
    "volumeTypes": [
      "string"
    ]
  },
  "totalNumberOfVolumes": 0,
  "volumes": [
    {
      "disableReasonBackup": [
        "string"
      ],
      "isBackupOn": false,
      "name": "string",
      "providerVolumeType": "string",
      "size": {
        "size": 0,
        "unit": "string"
      },
      "state": "string",
      "svmName": "string",
      "usedSize": {
        "size": 0,
        "unit": "string"
      },
      "uuid": "string",
      "volumeType": "string"
    }
  ]
}

Definitions

See Definitions

ListFilterByParam

Name Type Required Description

s

string

True

ListSortByParam

Name Type Required Description

s

string

True

AllowedValuesForVolumesListFilter

Name Type Required Description

diskTypes

array[string]

False

svmNames

array[string]

False

volumeStatus

array[string]

False

volumeTypes

array[string]

False

filteredNumberOfVolumes

hasNextPage

Capacity

Name Type Required Description

size

number

True

Size

unit

string

True

Unit

VolumeForBackupResponse

Name Type Required Description

disableReasonBackup

array[string]

True

isBackupOn

boolean

True

name

string

True

providerVolumeType

string

False

size

Capacity

True

state

string

False

svmName

string

False

usedSize

Capacity

False

uuid

string

False

volumeType

string

False