Skip to main content

Retrieve volumes

Contributors

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

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

Token usage: BlueXP user token.

Parameters

Name Type In Required Description

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": [
    {
      "name": "string",
      "file-system-id": "string",
      "status": "string",
      "svm": "string",
      "type": "string",
      "style": "string",
      "snapmirror-label": [
        "string"
      ]
    }
  ]
}
JSON
Copy

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