Get volumes
Contributors
Suggest changes
You can retrieve the list of volumes of Google Cloud system.
Choose the workflow to use based on the type of Cloud Volumes ONTAP deployment:
Get volumes for a single node
You can use this workflow to retrieve the list of volumes 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 query parameter.
2. Get the volumes
| HTTP method | Path |
|---|---|
GET |
/occm/api/gcp/vsa/volumes |
- curl example
curl --location --request GET 'https://api.bluexp.netapp.com/occm/api/gcp/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)string - Output
-
The JSON output example includes the list of volumes for the system.
- JSON output example
[
{
"name": "zivagg01vol01",
"uuid": "0x00000-0xx0-00xx-xx00-00xxxx000",
"svmName": "svm_zivgcp01we02",
"size": {
"size": 100.0,
"unit": "GB"
},
"usedSize": {
"size": 2.93731689453125E-4,
"unit": "GB"
},
"junctionPath": "/zivagg01vol01",
"volumeTotalInodes": 3112959,
"volumeUsedInodes": 96,
"mountPoint": "10.138.0.150:/zivagg01vol01",
"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_zivgcp01we02-zivagg01vol01",
"policyType": "custom",
"ips": [
"10.138.0.0/20"
],
"nfsVersion": [
"nfs3",
"nfs4"
]
},
"shareNames": [],
"shareInfo": [],
"parentVolumeName": "",
"rootVolume": false,
"state": "online",
"volumeType": "rw",
"aggregateName": "ziv01agg01",
"parentSnapshot": null,
"autoSizeMode": "grow",
"maxGrowSize": {
"size": 1100.0,
"unit": "GB"
},
"providerVolumeType": "pd-ssd",
"cloneNames": [],
"moving": false,
"primaryNoFailoverMountPoint": null,
"secondaryNoFailoverMountPoint": null,
"capacityTier": null,
"capacityTierUsedSize": null,
"cifsShareAccessPoint": null,
"primaryCifsShareAccessPoint": null,
"secondaryCifsShareAccessPoint": null,
"tieringPolicy": "none",
"tierInactiveUserData": null,
"tierInactiveUserDataPercent": null,
"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.986656ab5e3e11eb9cb735a0758d479a:vs.2",
"iscsiEnabled": false,
"isFlexGroupVolume": false
}
]Get volumes for a high availability pair
You can use this workflow to retrieve the list of volumes for an HA system.
1. Select the system
Perform the workflow Get system and choose the publicId value of the system for the workingEnvironmentId query parameter.
2. Get the volumes
| HTTP method | Path |
|---|---|
GET |
/occm/api/gcp/ha/volumes |
- curl example
curl --location --request GET 'https://api.bluexp.netapp.com/occm/api/gcp/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)string - Output
-
The JSON output example includes the list of volumes for the system.
- JSON output example
[
{
"name": "ziv01we02agg01havol01",
"uuid": "9b8eaf57-60f3-11eb-b6be-4f2f4a6477xx,
"svmName": "svm_ziv01we02ha",
"size": {
"size": 100.0,
"unit": "GB"
},
"usedSize": {
"size": 3.70025634765625E-4,
"unit": "GB"
},
"junctionPath": "/ziv01we02agg01havol01",
"volumeTotalInodes": 3112959,
"volumeUsedInodes": 96,
"mountPoint": "10.138.15.219:/ziv01we02agg01havol01",
"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_ziv01we02ha-ziv01we02agg01havol01",
"policyType": "custom",
"ips": [
"10.138.0.0/20"
],
"nfsVersion": [
"nfs3"
]
},
"shareNames": [],
"shareInfo": [],
"parentVolumeName": "",
"rootVolume": false,
"state": "online",
"volumeType": "rw",
"aggregateName": "ziv01we02agg01ha",
"parentSnapshot": null,
"autoSizeMode": "grow",
"maxGrowSize": {
"size": 1100.0,
"unit": "GB"
},
"providerVolumeType": "pd-ssd",
"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": 630784.0,
"unit": "Byte"
},
"cbsBackupsInfo": null,
"minimumCoolingDays": null,
"targetName": "iqn.1992-08.com.netapp:sn.d92dfebe60e811eba91c8xxx28f681feb:vs.3",
"iscsiEnabled": false,
"isFlexGroupVolume": false
}
]