Skip to main content

Retrieve a list of storage VMs

Contributors

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

Retrieves a list of storage VMs and their details from a specific working environment. 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.

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

svm

array[svm]

False
Example response 
{
  "svm": [
    {
      "id": "string",
      "name": "string",
      "aggregates": [
        {
          "id": "string",
          "name": "string",
          "disktype": "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

svm

Name Type Required Description

id

string

False

name

string

False

aggregates

array[aggregates]

False