Skip to main content

Retrieve a list of storage VMs

Retrieves a list of storage VMs and their details from a specific system. Use this to view information about storage VMs, including their associated aggregates and resource configurations.

HTTP method and endpoint

GET /account/{accountId}/providers/cloudmanager_cbs/api/v2/working-environment/{workingEnvironmentId}/svm

Token usage

NetApp Console user token.

Usage notes

This API retrieves the ID, name, and a list of aggregate objects that belongs to a storage VM. It also retrieves the aggregate disk type, aggregate tiering status, aggregate total size, and aggregate available size.

Parameters

Name Type In Required Description

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

svm

array[svm]

False

Example response
{
  "svm": [
    {
      "id": "string",
      "name": "string",
      "aggregates": [
        {
          "id": "string",
          "name": "string",
          "disktype": "string",
          "snaplock-type": "string"
        }
      ]
    }
  ]
}

Definitions

See Definitions

aggregates

Name Type Required Description

id

string

False

name

string

False

disktype

string

False

is-tiered

boolean

False

totalsize

number

False

available

number

False

used

number

False

snaplock-type

string

False

svm

Name Type Required Description

id

string

False

name

string

False

aggregates

array[aggregates]

False