Skip to main content

Retrieve volumes

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

Retrieves a list of volumes and their details from a specific system. This API endpoint retrieves the name, file-system-id, status, storage VM, type, style, capacity allocated, capacity used, and SnapMirror label information.

Token usage: NetApp Console user token.

Parameters

Name Type In Required Description

completeResponse

boolean

query

False

Returns only a partial response

name

string

query

False

Name of the volume. Example - volumeName* , *volumeName

language

string

query

False

Language of the volume. Example - C,C.UTF-8 etc

type

string

query

False

Type of the volume. Example - rw/RW (Read-Write) dp/DP (Data Protection) etc

style

string

query

False

Style of the volume. Example - flexvol|flexgroup|flexgroup-constituent

snaplockType

string

query

False

snaplockType of the volume. Example - compliance, enterprise and non-snaplock

max-records

number

query

False

Maximum records to return

cursor

string

query

False

The next volume UUID to use to retrieve results

accountId

string

path

True

Account ID

workingEnvironmentId

string

path

True

System ID

authorization

string

header

True

User token

X-Agent-Id

string

header

True

Request identifier

Response

Status: 200, Default response
Name Type Required Description

volume

array[volume]

False

num-records

number

False

cursor

string

False
Example response 
{
  "volume": [
    {
      "name": "string",
      "file-system-id": "string",
      "status": "string",
      "svm": "string",
      "type": "string",
      "style": "string",
      "snapmirror-label": [
        "string"
      ],
      "snaplock-type": "string",
      "language": "string"
    }
  ],
  "cursor": "string"
}

Definitions

See Definitions

capacity

Name Type Required Description

allocated

number

False

used

number

False

logicalUsedByAfs

number

False

volume

Name Type Required Description

name

string

False

file-system-id

string

False

status

string

False

svm

string

False

type

string

False

style

string

False

capacity

capacity

False

snapmirror-label

array[string]

False

snaplock-type

string

False

language

string

False