Retrieve volumes
Suggest changes
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 |
|
name |
string |
query |
False |
|
language |
string |
query |
False |
|
type |
string |
query |
False |
|
style |
string |
query |
False |
|
snaplockType |
string |
query |
False |
|
max-records |
number |
query |
False |
|
cursor |
string |
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 |
|
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 |
False |
||
snapmirror-label |
array[string] |
False |
|
snaplock-type |
string |
False |
|
language |
string |
False |