Volume

Get Volume

get

Get volume detail

Authorizations

x-api-keystringRequired

Path parameters

idinteger · int64RequiredExample: 0

Responses

200

OK

*/*

messagestringOptional

message

codeinteger · int32Optional

code

400

Bad Request

*/*

500

Internal Server Error

*/*

get/v2/volumes/{id}

GET /v2/volumes/{id} HTTP/1.1
x-api-key: YOUR_API_KEY
Accept: */*

{
  "message": "success",
  "code": 10000,
  "data": {
    "id": "449722593352847700",
    "name": "my-volume",
    "type": "NETWORK",
    "status": "AVAILABLE",
    "sizeBytes": 10737418240
  }
}

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

400

Bad Request

*/*

500

Internal Server Error

*/*

get/v2/volumes

GET /v2/volumes HTTP/1.1
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

{
  "message": "success",
  "code": 10000,
  "data": {
    "items": [
      {
        "id": "420436160829984768",
        "name": "my-volume",
        "type": "CLOUD_STORAGE",
        "status": "ACTIVE",
        "sizeBytes": "0",
        "sizeInGb": 0,
        "cost": "0.000000000000000000",
        "currency": "USD",
        "mountStatus": "UNMOUNTED",
        "mountCount": 0,
        "createdAt": "2026-06-05T09:24:12Z",
        "region": null,
        "failReason": null
      },
      {
        "id": "420435603029495808",
        "name": "my-volume",
        "type": "CLOUD_STORAGE",
        "status": "ACTIVE",
        "sizeBytes": "0",
        "sizeInGb": 0,
        "cost": "0.000000000000000000",
        "currency": "USD",
        "mountStatus": "UNMOUNTED",
        "mountCount": 0,
        "createdAt": "2026-06-05T09:21:59Z",
        "region": null,
        "failReason": null
      }
    ],
    "page": "1",
    "size": "10",
    "total": "2",
    "pages": "1"
  }
}

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

400

Bad Request

*/*

500

Internal Server Error

*/*

post/v2/volumes

POST /v2/volumes HTTP/1.1
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 76

{
  "name": "my-volume",
  "storageType": 2,
  "region": "us-west-1",
  "volumeSizeGb": 100
}

{
  "message": "success",
  "code": 10000,
  "data": {
    "id": "420497664434507776",
    "name": "my-volume",
    "type": "CLOUD_STORAGE",
    "status": "CREATING",
    "sizeBytes": "0",
    "sizeInGb": 0,
    "cost": "0",
    "currency": "USD",
    "mountStatus": "UNMOUNTED",
    "mountCount": 0,
    "createdAt": "2026-06-05T13:28:35Z",
    "region": null,
    "failReason": null
  }
}

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

400

Bad Request

*/*

500

Internal Server Error

*/*

delete/v2/volumes/{id}

DELETE /v2/volumes/{id} HTTP/1.1
x-api-key: YOUR_API_KEY
Accept: */*

{
  "message": "success",
  "code": 10000,
  "data": null
}