GET
/
org
/
{org}
/
gvc
/
{gvc}
/
volumeset
/
{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": "xfs",
    "snapshots": {
      "createFinalSnapshot": true,
      "retentionDuration": "<string>",
      "schedule": "<string>"
    },
    "autoscaling": {
      "maxCapacity": 123,
      "minFreePercentage": 123,
      "scalingFactor": 123
    }
  },
  "status": {
    "parentId": "<string>",
    "usedByWorkload": "<string>",
    "bindingId": "<string>",
    "locations": [
      {
        "name": "<string>",
        "volumes": [
          {
            "lifecycle": "creating",
            "storageDeviceId": "<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": {}
          }
        ],
        "desiredVolumeCount": 123,
        "clusterId": "<string>"
      }
    ]
  },
  "gvc": {}
}

Authorizations

Authorization
string
headerrequired

Service account key can be used as API keys

Path Parameters

org
string
required
gvc
string
required
name
string
required

Response

200 - application/json
id
string
name
string
kind
string
version
integer
description
string
tags
object
created
string
lastModified
string
links
object[]
spec
object
status
object
gvc
object