volumeset
Perform a Patch on a volumeset by name
Overview
agent
auditctx
cloudaccount
- GETGet a cloud account by name
- DELDelete an cloud account by name
- PATCHPerform a Patch on a cloud account by name
- GETGet all cloud accounts
- POSTCreate a cloud account
- POSTGet all cloud accounts based on a query
- GETGet the access report for a cloud account by name
- GETGet available permissions for a cloud account resource type
domain
group
gvc
identity
- GETGet an identity by GVC and name
- DELDelete an identity by GVC and name
- PATCHPerform a Patch on an identity by name
- GETGet all identities in a GVC
- POSTCreate an identity
- GETGet all identities from all GVCs
- POSTGet all GVC identities based on a query
- GETGet the access report for an identity by GVC and name
- GETGet available permissions for an identity
image
location
org
policy
quota
secret
- GETGet a secret by name
- DELDelete a secret by name
- PATCHPerform a Patch on an IP Set by name
- GETGet all secrets
- POSTCreate a secret
- GETGet the sensitive content of a secret by name
- POSTGet all secrets based on a query
- GETGet the access report for a secret by name
- GETGet available permissions for a secret resource type
serviceaccount
- GETGet a service account by name
- DELDelete a service account by name
- PATCHPerform a Patch on a service account by name
- GETGet all service accounts
- POSTCreate a service account
- POSTGet all service accounts based on a query
- GETGet the access report for a service account by name
- POSTAdd a key to a service account
- GETGet available permissions for a service account resource type
task
user
volumeset
- GETGet a volumeset by GVC and name
- DELDelete a volumeset by name
- PATCHPerform a Patch on a volumeset by name
- GETList volumesets in a GVC you are authorized to view
- POSTCreate a volumeset
- GETGet all volumesets
- POSTGet all volumesets based on a query
- GETGet the access report for a volumeset by GVC and name
- GETGet available permissions for a volumeset resource type
workload
- GETGet a workload by GVC and name
- DELDelete a workload by name
- PATCHPerform a Patch on a workload by name
- GETGet a deployment by GVC, workload and name
- GETList workloads in a GVC you are authorized to view
- POSTCreate a workload
- GETGet all workloads
- GETList deployments in a workload
- POSTGet all workloads based on a query
- GETGet the access report for a workload by GVC and name
- GETGet available permissions for a workload resource type
volumeset
Perform a Patch on a volumeset by name
PATCH
/
org
/
{org}
/
gvc
/
{gvc}
/
volumeset
/
{name}
curl --request PATCH \
--url https://api.cpln.io/org/{org}/gvc/{gvc}/volumeset/{name} \
--header 'Content-Type: application/json' \
--data '{
"$drop": [
"description"
],
"description": "<string>",
"tags": {},
"$replace/tags": {},
"spec": {
"$drop": [
"initialCapacity"
],
"initialCapacity": 123,
"performanceClass": "general-purpose-ssd",
"storageClassSuffix": "<string>",
"fileSystemType": "ext4",
"snapshots": {
"$drop": [
"createFinalSnapshot"
],
"createFinalSnapshot": true,
"retentionDuration": "<string>",
"schedule": "<string>"
},
"$replace/snapshots": {
"createFinalSnapshot": true,
"retentionDuration": "<string>",
"schedule": "<string>"
},
"autoscaling": {
"$drop": [
"maxCapacity"
],
"maxCapacity": 123,
"minFreePercentage": 123,
"scalingFactor": 123
},
"$replace/autoscaling": {
"maxCapacity": 123,
"minFreePercentage": 123,
"scalingFactor": 123
},
"mountOptions": {
"$drop": [
"resources"
],
"resources": {
"$drop": [
"maxCpu"
],
"maxCpu": "2000m",
"minCpu": "500m",
"minMemory": "1Gi",
"maxMemory": "2Gi"
},
"$replace/resources": {
"maxCpu": "2000m",
"minCpu": "500m",
"minMemory": "1Gi",
"maxMemory": "2Gi"
}
},
"$replace/mountOptions": {
"resources": {
"maxCpu": "2000m",
"minCpu": "500m",
"minMemory": "1Gi",
"maxMemory": "2Gi"
}
}
},
"$replace/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"
}
}
},
"gvc": {},
"$replace/gvc": {}
}'
{
"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
Service account key can be used as API keys
Body
application/json
The body is of type object
.
Response
200
application/json
Success
The response is of type object
.
curl --request PATCH \
--url https://api.cpln.io/org/{org}/gvc/{gvc}/volumeset/{name} \
--header 'Content-Type: application/json' \
--data '{
"$drop": [
"description"
],
"description": "<string>",
"tags": {},
"$replace/tags": {},
"spec": {
"$drop": [
"initialCapacity"
],
"initialCapacity": 123,
"performanceClass": "general-purpose-ssd",
"storageClassSuffix": "<string>",
"fileSystemType": "ext4",
"snapshots": {
"$drop": [
"createFinalSnapshot"
],
"createFinalSnapshot": true,
"retentionDuration": "<string>",
"schedule": "<string>"
},
"$replace/snapshots": {
"createFinalSnapshot": true,
"retentionDuration": "<string>",
"schedule": "<string>"
},
"autoscaling": {
"$drop": [
"maxCapacity"
],
"maxCapacity": 123,
"minFreePercentage": 123,
"scalingFactor": 123
},
"$replace/autoscaling": {
"maxCapacity": 123,
"minFreePercentage": 123,
"scalingFactor": 123
},
"mountOptions": {
"$drop": [
"resources"
],
"resources": {
"$drop": [
"maxCpu"
],
"maxCpu": "2000m",
"minCpu": "500m",
"minMemory": "1Gi",
"maxMemory": "2Gi"
},
"$replace/resources": {
"maxCpu": "2000m",
"minCpu": "500m",
"minMemory": "1Gi",
"maxMemory": "2Gi"
}
},
"$replace/mountOptions": {
"resources": {
"maxCpu": "2000m",
"minCpu": "500m",
"minMemory": "1Gi",
"maxMemory": "2Gi"
}
}
},
"$replace/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"
}
}
},
"gvc": {},
"$replace/gvc": {}
}'
{
"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": {}
}