Get volumes

Contributors netapp-ranuk

You can retrieve the list of volumes.

Choose the correct workflow depending on the type of Cloud Volumes ONTAP deployment:

Get volumes for single node

You can use this workflow to retrieve a list of volumes for a single node working environment.

1. Select the working environment

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

2. Get the volumes

HTTP method Path

GET

/occm/api/vsa/volumes

curl example
curl --location --request GET 'https://cloudmanager.cloud.netapp.com/occm/api/vsa/volumes?workingEnvironmentId=<WORKING_ENV_ID>' --header 'Content-Type: application/json' --header 'x-agent-id: <AGENT_ID>' --header 'Authorization: Bearer <ACCESS_TOKEN>'
Input

Query parameter <WORKING_ENV_ID> (workingEnvironmentId)

Output

The JSON output example includes the list of volumes for the working environment.

JSON output example
[
    {
        "name": "ziv02vol01",
        "uuid": "cb488216-5bd1-11eb-8a9b-615eb82c79d8",
        "svmName": "svm_ziv01we02",
        "size": {
            "size": 100.0,
            "unit": "GB"
        },
        "usedSize": {
            "size": 5.18798828125E-4,
            "unit": "GB"
        },
        "junctionPath": "/ziv02vol01",
        "volumeTotalInodes": 3112959,
        "volumeUsedInodes": 96,
        "mountPoint": "172.31.1.199:/ziv02vol01",
        "compressionSpaceSaved": {
            "size": 0.0,
            "unit": "GB"
        },
        "deduplicationSpaceSaved": {
            "size": 0.0,
            "unit": "GB"
        },
        "thinProvisioning": true,
        "compression": true,
        "deduplication": true,
        "snapshotPolicy": "default",
        "securityStyle": "unix",
        "exportPolicyInfo": {
            "name": "export-svm_ziv01we02-ziv02vol01",
            "policyType": "custom",
            "ips": [
                "172.31.0.0/16"
            ],
            "nfsVersion": [
                "nfs3"
            ]
        },
        "shareNames": [],
        "shareInfo": [],
        "parentVolumeName": "",
        "rootVolume": false,
        "state": "online",
        "volumeType": "rw",
        "aggregateName": "aggr1",
        "parentSnapshot": null,
        "autoSizeMode": "grow",
        "maxGrowSize": {
            "size": 1100.0,
            "unit": "GB"
        },
        "providerVolumeType": "gp2",
        "cloneNames": [],
        "moving": false,
        "primaryNoFailoverMountPoint": null,
        "secondaryNoFailoverMountPoint": null,
        "capacityTier": null,
        "capacityTierUsedSize": null,
        "cifsShareAccessPoint": null,
        "primaryCifsShareAccessPoint": null,
        "secondaryCifsShareAccessPoint": null,
        "tieringPolicy": "none",
        "tierInactiveUserData": {
            "size": 0.0,
            "unit": "GB"
        },
        "tierInactiveUserDataPercent": 0,
        "comment": null,
        "qosPolicyGroupName": null,
        "snaplockType": "non_snaplock",
        "constituentsAggregates": [],
        "snapshotsUsedSize": {
            "size": 1597440.0,
            "unit": "Byte"
        },
        "cbsBackupsInfo": null,
        "minimumCoolingDays": null,
        "targetName": "iqn.1992-08.com.netapp:sn.7d147b755bd011ebb076ef46475a0933:vs.2",
        "iscsiEnabled": false,
        "isFlexGroupVolume": false
    }
]

Get volumes for high availability pair

You can use this workflow to retrieve a list of volumes for an HA working environment.

1. Select the working environment

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

2. Get the volumes

HTTP method Path

GET

/occm/api/aws/ha/volumes

curl example
curl --location --request GET 'https://cloudmanager.cloud.netapp.com/occm/api/aws/ha/volumes?workingEnvironmentId=<WORKING_ENV_ID>' --header 'Content-Type: application/json' --header 'x-agent-id: <AGENT_ID>' --header 'Authorization: Bearer <ACCESS_TOKEN>'
Input

Query parameter <WORKING_ENV_ID> (workingEnvironmentId)

Output

The JSON output example includes the list of volumes for the working environment.

[
{
        "name": "ziv04we01haagg01vol01",
        "uuid": "728ad225-61ca-11eb-81ba-637783e50391",
        "svmName": "svm_ziv04we01ha",
        "size": {
            "size": 100.0,
            "unit": "GB"
        },
        "usedSize": {
            "size": 2.93731689453125E-4,
            "unit": "GB"
        },
        "junctionPath": "/ziv04we01haagg01vol01",
        "volumeTotalInodes": 3112959,
        "volumeUsedInodes": 96,
        "mountPoint": "2.2.2.2:/ziv04we01haagg01vol01",
        "compressionSpaceSaved": {
            "size": 0.0,
            "unit": "GB"
        },
        "deduplicationSpaceSaved": {
            "size": 0.0,
            "unit": "GB"
        },
        "thinProvisioning": true,
        "compression": true,
        "deduplication": true,
        "snapshotPolicy": "default",
        "securityStyle": "unix",
        "exportPolicyInfo": {
            "name": "export-svm_ziv04we01ha-ziv04we01haagg01vol01",
            "policyType": "custom",
            "ips": [
                "172.31.0.0/16"
            ],
            "nfsVersion": [
                "nfs3",
                "nfs4"
            ]
        },
        "shareNames": [],
        "shareInfo": [],
        "parentVolumeName": "",
        "rootVolume": false,
        "state": "online",
        "volumeType": "rw",
        "aggregateName": "aggr1",
        "parentSnapshot": null,
        "autoSizeMode": "grow",
        "maxGrowSize": {
            "size": 1100.0,
            "unit": "GB"
        },
        "providerVolumeType": "gp2",
        "cloneNames": [],
        "moving": false,
        "primaryNoFailoverMountPoint": "172.31.1.36:/ziv04we01haagg01vol01",
        "secondaryNoFailoverMountPoint": "172.31.2.210:/ziv04we01haagg01vol01",
        "capacityTier": null,
        "capacityTierUsedSize": null,
        "cifsShareAccessPoint": null,
        "primaryCifsShareAccessPoint": null,
        "secondaryCifsShareAccessPoint": null,
        "tieringPolicy": "none",
        "tierInactiveUserData": {
            "size": 0.0,
            "unit": "GB"
        },
        "tierInactiveUserDataPercent": 0,
        "comment": null,
        "qosPolicyGroupName": null,
        "snaplockType": "non_snaplock",
        "constituentsAggregates": [],
        "snapshotsUsedSize": {
            "size": 0.0,
            "unit": "Byte"
        },
        "cbsBackupsInfo": null,
        "minimumCoolingDays": null,
        "targetName": "iqn.1992-08.com.netapp:sn.c4a88d8c618511eba2c7672081bef253:vs.3",
        "iscsiEnabled": false,
        "isFlexGroupVolume": false
    }
]