Get aggregates

09/29/2025 Contributors

You can retrieve a list of available disk aggregates for Cloud Volumes ONTAP in Google Cloud.

Choose the workflow to use based on the type of Cloud Volumes ONTAP deployment:

Single Node
HA pair

Get aggregates for a single node

You can use this workflow to retrieve a list of aggregates for a single node system.

1. Select the system

Perform the workflow Get system and choose the publicId value of the system for the workingEnvironmentId path parameter.

2. Get the list of aggregates

HTTP method	Path
GET	/occm/api/gcp/vsa/aggregates/{workingEnvironmentId}

curl example

curl --location --request GET 'https://api.bluexp.netapp.com/occm/api/gcp/vsa/aggregates/<WORKING_ENV_ID>' --header 'Content-Type: application/json' --header 'x-agent-id: <AGENT_ID>' --header 'Authorization: Bearer <ACCESS_TOKEN>'

Input

Path parameter:

<WORKING_ENV_ID> (workingEnvironmentId) string

Output

An array of aggregates is returned for the system, as shown in the JSON output example.

The capacity (sizes) in the output are in MB/GB/TB (1000th order) because these are ONTAP aggregates, whereas in the NetApp Console the capacity is specified as MiB, GiB (1024 order).

JSON output example

[
    {
        "name": "aggr1",
        "availableCapacity": {
            "size": 87.55,
            "unit": "GB"
        },
        "totalCapacity": {
            "size": 88.57,
            "unit": "GB"
        },
        "usedCapacity": {
            "size": 1.02,
            "unit": "GB"
        },
        "volumes": [
            {
                "name": "svm_zivgcp01we02_root",
                "totalSize": {
                    "size": 1.0,
                    "unit": "GB"
                },
                "usedSize": {
                    "size": 7.59124755859375E-4,
                    "unit": "GB"
                },
                "thinProvisioned": false,
                "isClone": false,
                "rootVolume": true
            }
        ],
        "providerVolumes": [
            {
                "id": "00000000000000000",
                "name": "zivgcp01we02datadisk1",
                "size": {
                    "size": 100.0,
                    "unit": "GB"
                },
                "state": "READY",
                "device": "zivgcp01we02datadisk1",
                "instanceId": "zivgcp01we02",
                "diskType": "pd-ssd",
                "encrypted": true,
                "iops": null
            }
        ],
        "disks": [
            {
                "name": "NET-1.2",
                "position": "data",
                "ownerNode": "zivgcp01we02-01",
                "device": "zivgcp01we02datadisk1",
                "vmDiskProperties": null
            }
        ],
        "state": "online",
        "encryptionType": "cloudEncrypted",
        "encryptionKeyId": null,
        "isRoot": false,
        "homeNode": "zivgcp01we02-01",
        "ownerNode": "zivgcp01we02-01",
        "capacityTier": null,
        "capacityTierUsed": null,
        "sidlEnabled": true,
        "snaplockType": "non_snaplock"
    }
]

Get aggregates for a high availability pair

You can use this workflow to retrieve a list of aggregates for an HA system.