Skip to main content

Retrieve volumes

Contributors

GET /api/v1/accounts/{accountId}/working-environments/{weId}/{provider}/volumes

Retrieves the volumes associated with a working environment.

Parameters

Name Type In Required Description

nextUuid

string

query

False

maxRecords

number

query

False

Max records to return, default 1000

accountId

string

path

True

Tenancy Account ID

weId

string

path

True

Working Environment ID

provider

[nil, nil, nil, nil]

path

True

x-agent-id

string

header

True

Connector Id

x-workspace-id

string

header

False

Workspace Id

Response

Status: 200, Default Response
Name Type Required Description

volumes

array[volumes]

True

nextUuid

string

False
Example response 
{
  "volumes": [
    {
    }
  ],
  "nextUuid": "string"
}

Definitions

See Definitions

volumes

Name Type Required Description

name

string

True

svmName

string

False

ipAddress

string

False

status

string

True

Volume status: online, offline, failed

path

string

False

exportPolicy

string

False

type

string

True

volumeUid

string

True

usedCapacity

number

False

allocatedCapacity

number

True

poolName

string

False

For ANF - capacity pool name

netAppAccountName

string

False

For ANF - NetApp account name

protocol

array[string]

False

For ANF - determines the volume protocol

versions

array[string]

False