Volume

Get Volume

get

Get volume detail

Authorizations
x-api-keystringRequired
Path parameters
idinteger · int64RequiredExample: 0
Responses
200

OK

*/*
messagestringOptional

message

codeinteger · int32Optional

code

get
/v2/volumes/{id}

List Volumes

get

List cloud storage volumes

Authorizations
x-api-keystringRequired
Query parameters
pageinteger · int64Optional

Page number, 1-based

Example: 1
sizeinteger · int64Optional

Page size

Example: 10
typestring · enumOptional

Volume type. First version only supports CLOUD_STORAGE.

Example: CLOUD_STORAGEPossible values:
Body
objectOptional
Responses
200

OK

*/*
messagestringOptional

message

codeinteger · int32Optional

code

get
/v2/volumes

Create Volume

post

Create a cloud storage volume

Authorizations
x-api-keystringRequired
Query parameters
sizeInGbintegerOptionalExample: 100
Body

Volume v2 create request

namestring · min: 1Required

Volume name

Example: my-volume
typestring · enumOptional

Volume type. First version only supports CLOUD_STORAGE.

Example: CLOUD_STORAGEPossible values:
Responses
200

OK

*/*
messagestringOptional

message

codeinteger · int32Optional

code

post
/v2/volumes

Delete Volume

delete

Delete a volume

Authorizations
x-api-keystringRequired
Path parameters
idinteger · int64RequiredExample: 420497664434507800
Responses
200

OK

*/*
messagestringOptional

message

Example: success
codeinteger · int32Optional

code

Example: 10000
dataanyOptional

data

delete
/v2/volumes/{id}

Last updated

Was this helpful?