Skip to main content

Get aggregates

Contributors netapp-ranuk

You can retrieve a list of available disk aggregates.

Step 1. Select the working environment to use

Perform the workflow Get working environments and choose the publicId value of the working environment for the workingEnvironmentId path parameter.

Step 2. Get a list of aggregates

You can issue a REST API call to retrieve a list of aggregates.

HTTP method and endpoint

This REST API call uses the following method and endpoint.

HTTP method Path

GET

/occm/api/onprem/aggregates/{workingEnvironmentId}
Curl example
curl --request GET \
--location "https://cloudmanager.cloud.netapp.com/occm/api/onprem/aggregates?workingEnvironmentId=<ONPREM_WORKING_ENV_ID>" \
--header "Content-Type: application/json" \
--header "x-agent-id: <AGENT_ID>" \
--header "Authorization: Bearer <ACCESS_TOKEN>"
Additional input parameters

The JSON input example includes the minimum list of parameters.

Parameter Type Required Description

workingEnvironmentId <WORKING_ENV_ID>

Path

Yes

Identifies the working environment ID
JSON output example

An array of aggregates for the indicated working environment is returned as shown in the JSON output example.

Example output
[
  {
    "name": "aggr2",
    "totalCapacity": {
      "size": 47xxxxxx,
      "unit": "Byte"
    },
    "availableCapacity": {
      "size": 4754xxxxxxxxx,
      "unit": "Byte"
    },
    "state": "online",
    "isInactiveDataReportingEnabled": false,
    "isObjectStoreAttachEligible": true,
    "objectStoreName": null,
    "usedCapacity": {
      "size": 1166xxxx,
      "unit": "Byte"
    },
    "tieringRestriction": null,
    "availabilityState": null
  },
  {
    "name": "aggr1",
    "totalCapacity": {
      "size": 47560xxxxx,
      "unit": "Byte"
    },
    "availableCapacity": {
      "size": 474521083904,
      "unit": "Byte"
    },
    "state": "online",
    "isInactiveDataReportingEnabled": false,
    "isObjectStoreAttachEligible": false,
    "objectStoreName": "StorageAccount",
    "usedCapacity": {
      "size": 1086xxxxxx,
      "unit": "Byte"
    },
    "tieringRestriction": null,
    "availabilityState": "available"
  }
]