Patch a volume

PATCH

/api/v1/volumes/{name}/size

Patch the size of the latest version of an existing volume via create a new volume and copy the old volume data to the new volume.

Including expand and shrink of two operations, if the size is the same before and after the operation,it will be skipped.

If the size already used is larger than the size after shrink, then shrink operation will fail.

The old version volume will be deleted.
For example, if bar-1 calls the /api/v1/volumes/:name/size and create bar-2, bar-1 will be deleted.

Request

Path Params

name

string

required

Volume Name

Example:

bar

Body Params application/json

size

string

required

Size

Example

{
  "size": "50GB"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH 'http://127.0.0.1:2378/api/v1/volumes/bar/size' \
--header 'Content-Type: application/json' \
--data-raw '{
    "size": "50GB"
}'

Responses

🟢200OK

application/json

Body

code

integer

required

msg

string

required

data

object

required

name

string

required

Volume name of the new version created

size

string

required

Volume size of the new version created

Example

{
  "code": 200,
  "msg": "Success",
  "data": {
    "name": "bar-2",
    "size": "50GB"
  }
}

Modified at 2024-01-23 01:58:01

Create a volume

Get version info about a volume