GET
/
org
/
{org}
/
gvc
/
{gvc}
/
volumeset
/
{name}
Get a volumeset by GVC and name
curl --request GET \
  --url https://api.cpln.io/org/{org}/gvc/{gvc}/volumeset/{name}
{
  "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",
    "snapshots": {
      "createFinalSnapshot": true,
      "retentionDuration": "<string>",
      "schedule": "<string>"
    },
    "autoscaling": {
      "maxCapacity": 123,
      "minFreePercentage": 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": {}
}

Authorizations

Authorization
string
header
required

Service account key can be used as API keys

Path Parameters

org
string
required
gvc
string
required
name
string
required

Response

Success

id
string
name
string
Maximum length: 64
kind
string
version
integer
description
string
Maximum length: 250
tags
object
created
string<date-time>
lastModified
string<date-time>
spec
object
status
object
gvc
object