curl --request GET \
--url https://api.cpln.io/org/{org}/gvc/{gvc}/volumeset/{name} \
--header 'Authorization: <api-key>'{
"id": "<string>",
"name": "<string>",
"kind": "<string>",
"version": 123,
"description": "<string>",
"tags": {},
"created": "2023-11-07T05:31:56Z",
"lastModified": "2023-11-07T05:31:56Z",
"links": [
{
"rel": "<string>",
"href": "<string>"
}
],
"spec": {
"initialCapacity": 123,
"performanceClass": "general-purpose-ssd",
"storageClassSuffix": "<string>",
"fileSystemType": "ext4",
"customEncryption": {
"regions": {}
},
"snapshots": {
"createFinalSnapshot": true,
"retentionDuration": "<string>",
"schedule": "<string>"
},
"autoscaling": {
"maxCapacity": 123,
"minFreePercentage": 123,
"scalingFactor": 123,
"predictive": {
"enabled": true,
"lookbackHours": 123,
"projectionHours": 123,
"minDataPoints": 123,
"minGrowthRateGBPerHour": 123,
"scalingFactor": 123
}
},
"mountOptions": {
"resources": {
"maxCpu": "2000m",
"minCpu": "500m",
"minMemory": "1Gi",
"maxMemory": "2Gi"
}
}
},
"status": {
"parentId": "<string>",
"usedByWorkload": "<string>",
"workloadLinks": [
"<string>"
],
"bindingId": "<string>",
"locations": [
{
"name": "<string>",
"volumes": [
{
"lifecycle": "creating",
"storageDeviceId": "<string>",
"oldStorageDeviceIds": [
"<string>"
],
"resourceName": "<string>",
"index": 123,
"currentSize": 123,
"currentBytesUsed": 123,
"iops": 123,
"throughput": 123,
"driver": "<string>",
"volumeSnapshots": [
{
"name": "<string>",
"id": "<string>",
"created": "2023-11-07T05:31:56Z",
"expires": "2023-11-07T05:31:56Z",
"size": 123,
"tags": [
{}
]
}
],
"attributes": {},
"zone": "<string>"
}
],
"desiredVolumeCount": 123,
"clusterId": "<string>"
}
]
},
"gvc": {}
}Response will contain the requested volumeset if the caller is authorized to view it
curl --request GET \
--url https://api.cpln.io/org/{org}/gvc/{gvc}/volumeset/{name} \
--header 'Authorization: <api-key>'{
"id": "<string>",
"name": "<string>",
"kind": "<string>",
"version": 123,
"description": "<string>",
"tags": {},
"created": "2023-11-07T05:31:56Z",
"lastModified": "2023-11-07T05:31:56Z",
"links": [
{
"rel": "<string>",
"href": "<string>"
}
],
"spec": {
"initialCapacity": 123,
"performanceClass": "general-purpose-ssd",
"storageClassSuffix": "<string>",
"fileSystemType": "ext4",
"customEncryption": {
"regions": {}
},
"snapshots": {
"createFinalSnapshot": true,
"retentionDuration": "<string>",
"schedule": "<string>"
},
"autoscaling": {
"maxCapacity": 123,
"minFreePercentage": 123,
"scalingFactor": 123,
"predictive": {
"enabled": true,
"lookbackHours": 123,
"projectionHours": 123,
"minDataPoints": 123,
"minGrowthRateGBPerHour": 123,
"scalingFactor": 123
}
},
"mountOptions": {
"resources": {
"maxCpu": "2000m",
"minCpu": "500m",
"minMemory": "1Gi",
"maxMemory": "2Gi"
}
}
},
"status": {
"parentId": "<string>",
"usedByWorkload": "<string>",
"workloadLinks": [
"<string>"
],
"bindingId": "<string>",
"locations": [
{
"name": "<string>",
"volumes": [
{
"lifecycle": "creating",
"storageDeviceId": "<string>",
"oldStorageDeviceIds": [
"<string>"
],
"resourceName": "<string>",
"index": 123,
"currentSize": 123,
"currentBytesUsed": 123,
"iops": 123,
"throughput": 123,
"driver": "<string>",
"volumeSnapshots": [
{
"name": "<string>",
"id": "<string>",
"created": "2023-11-07T05:31:56Z",
"expires": "2023-11-07T05:31:56Z",
"size": 123,
"tags": [
{}
]
}
],
"attributes": {},
"zone": "<string>"
}
],
"desiredVolumeCount": 123,
"clusterId": "<string>"
}
]
},
"gvc": {}
}Documentation Index
Fetch the complete documentation index at: https://docs.controlplane.com/llms.txt
Use this file to discover all available pages before exploring further.
Service account key can be used as API keys
Success
64250Show child attributes
Show child attributes
Show child attributes