This is the multi-page printable view of this section. Click here to print.
List volumes
1 - 1.2
scpcli virtualserver volume list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--offset <value>]
[--name <value>]
[--state <value>]
[--bootable <value>]
[--long]
Description
List volumes.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| with_count optional | boolean | Whether to show count | True |
| limit optional | integer | Page size of items. Max value is 1000. | 20 |
| marker optional | string | The last item's ID from previous request | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| sort optional | string | Comma-separated list of sort keys and optional sort directions in the form of | created_at:desc |
| offset optional | integer | Index of where to start in the list | 0 |
| name optional | string | Volume name | volume01 |
| state optional | string | Volume state | available |
| bootable optional | boolean | Bootable | False |
Responses
| Name | Description | Example |
|---|---|---|
| id | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
| bootable | Bootable | False |
| created_at | Created at | |
| encrypted | Encrypted Requires --long option | True |
| max_iops | The number of distinct read or write operations a volume can process in a single second. Requires --long option | 10000 |
| max_throughput | The actual amount of data (volume) transferred to or from the storage device per second. Requires --long option | 500 |
| modified_at | Modified at Requires --long option | 2025-07-26T12:00:00Z |
| multiattach | Connect to two or more servers, no restriction on the number of connected servers per volume, and Virtual Server can connect up to 26 volumes. Requires --long option | False |
| name | Volume name | volume01 |
| servers | Attached servers Requires --long option | |
| size | Volume size | 104 |
| snapshot_id | Snapshot ID Requires --long option | cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 |
| state | Volume state | available |
| user_id | User ID Requires --long option | 570907805e5447be84b618450ef52o0t |
| volume_image_metadata | Volume Image metadata Requires --long option | |
| volume_type | Volume type | SSD |
| volume_type_id | Volume type ID Requires --long option | c643ac35-3aec-43e6-b97a-3d6f666c5207 |
2 - 1.1
scpcli virtualserver volume list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--offset <value>]
[--name <value>]
[--state <value>]
[--bootable <value>]
[--long]
Description
List volumes.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| with_count optional | boolean | Whether to show count | True |
| limit optional | integer | Page size of items. Max value is 1000. | 20 |
| marker optional | string | The last item's ID from previous request | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| sort optional | string | Comma-separated list of sort keys and optional sort directions in the form of | created_at:desc |
| offset optional | integer | Index of where to start in the list | 0 |
| name optional | string | Volume name | volume01 |
| state optional | string | Volume state | available |
| bootable optional | boolean | Bootable | False |
Responses
| Name | Description | Example |
|---|---|---|
| id | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
| bootable | Bootable | False |
| created_at | Created at | |
| encrypted | Encrypted Requires --long option | True |
| modified_at | Modified at Requires --long option | 2025-07-26T12:00:00Z |
| multiattach | Connect to two or more servers, no restriction on the number of connected servers per volume, and Virtual Server can connect up to 26 volumes. Requires --long option | False |
| name | Volume name | volume01 |
| servers | Attached servers Requires --long option | |
| size | Volume size | 104 |
| snapshot_id | Snapshot ID Requires --long option | cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 |
| state | Volume state | available |
| user_id | User ID Requires --long option | 570907805e5447be84b618450ef52o0t |
| volume_image_metadata | Volume Image metadata Requires --long option | |
| volume_type | Volume type | SSD |
| volume_type_id | Volume type ID Requires --long option | c643ac35-3aec-43e6-b97a-3d6f666c5207 |
3 - 1.0
scpcli virtualserver volume list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--offset <value>]
[--name <value>]
[--state <value>]
[--bootable <value>]
[--long]
Description
List volumes.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| with_count optional | boolean | Whether to show count | True |
| limit optional | integer | Page size of items. Max value is 1000. | 20 |
| marker optional | string | The last item's ID from previous request | 2a9be312-5d4b-4bc8-b2ae-35100fa9241f |
| sort optional | string | Comma-separated list of sort keys and optional sort directions in the form of | created_at:desc |
| offset optional | integer | Index of where to start in the list | 0 |
| name optional | string | Volume name | volume01 |
| state optional | string | Volume state | available |
| bootable optional | boolean | Bootable | False |
Responses
| Name | Description | Example |
|---|---|---|
| id | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
| bootable | Bootable | False |
| created_at | Created at | |
| encrypted | Encrypted Requires --long option | True |
| modified_at | Modified at Requires --long option | 2025-07-26T12:00:00Z |
| multiattach | Connect to two or more servers, no restriction on the number of connected servers per volume, and Virtual Server can connect up to 26 volumes. Requires --long option | False |
| name | Volume name | volume01 |
| servers | Attached servers Requires --long option | |
| size | Volume size | 104 |
| snapshot_id | Snapshot ID Requires --long option | cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 |
| state | Volume state | available |
| user_id | User ID Requires --long option | 570907805e5447be84b618450ef52o0t |
| volume_image_metadata | Volume Image metadata Requires --long option | |
| volume_type | Volume type | SSD |
| volume_type_id | Volume type ID Requires --long option | c643ac35-3aec-43e6-b97a-3d6f666c5207 |