This is the multi-page printable view of this section. Click here to print.
Show Volume's details
1 - 1.3
scp-cli virtualserver volume show
--volume_id <value>
Description
Show a Volume’s details.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
Responses
| Name | Description | Example |
|---|---|---|
| id | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
| bootable | Bootable | False |
| created_at | Created at | |
| encrypted | Encrypted | True |
| max_iops | The number of distinct read or write operations a volume can process in a single second. | 10000 |
| max_throughput | The actual amount of data (volume) transferred to or from the storage device per second. | 500 |
| modified_at | Modified at | 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. | False |
| name | Volume name | volume01 |
| servers | Attached servers | [] |
| size | Volume size | 104 |
| snapshot_id | Snapshot ID | cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 |
| state | Volume state | available |
| user_id | User ID | 570907805e5447be84b618450ef52o0t |
| volume_image_metadata | Volume Image metadata | {} |
| volume_type | Volume type | SSD |
| volume_type_id | Volume type ID | c643ac35-3aec-43e6-b97a-3d6f666c5207 |
2 - 1.2
scp-cli virtualserver volume show
--volume_id <value>
Description
Show a Volume’s details.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20260831 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| volume_id required | string | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
Responses
| Name | Description | Example |
|---|---|---|
| id | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
| bootable | Bootable | False |
| created_at | Created at | |
| encrypted | Encrypted | True |
| max_iops | The number of distinct read or write operations a volume can process in a single second. | 10000 |
| max_throughput | The actual amount of data (volume) transferred to or from the storage device per second. | 500 |
| modified_at | Modified at | 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. | False |
| name | Volume name | volume01 |
| servers | Attached servers | [] |
| size | Volume size | 104 |
| snapshot_id | Snapshot ID | cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 |
| state | Volume state | available |
| user_id | User ID | 570907805e5447be84b618450ef52o0t |
| volume_image_metadata | Volume Image metadata | {} |
| volume_type | Volume type | SSD |
| volume_type_id | Volume type ID | c643ac35-3aec-43e6-b97a-3d6f666c5207 |
3 - 1.1
scp-cli virtualserver volume show
--volume_id <value>
Description
Show a Volume’s details.
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 |
|---|---|---|---|
| volume_id required | string | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
Responses
| Name | Description | Example |
|---|---|---|
| id | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
| bootable | Bootable | False |
| created_at | Created at | |
| encrypted | Encrypted | True |
| modified_at | Modified at | 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. | False |
| name | Volume name | volume01 |
| servers | Attached servers | [] |
| size | Volume size | 104 |
| snapshot_id | Snapshot ID | cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 |
| state | Volume state | available |
| user_id | User ID | 570907805e5447be84b618450ef52o0t |
| volume_image_metadata | Volume Image metadata | {} |
| volume_type | Volume type | SSD |
| volume_type_id | Volume type ID | c643ac35-3aec-43e6-b97a-3d6f666c5207 |
4 - 1.0
scp-cli virtualserver volume show
--volume_id <value>
Description
Show a Volume’s details.
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 |
|---|---|---|---|
| volume_id required | string | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
Responses
| Name | Description | Example |
|---|---|---|
| id | Volume ID | 3f500f00-ed80-4566-a057-e31760226f9a |
| bootable | Bootable | False |
| created_at | Created at | |
| encrypted | Encrypted | True |
| modified_at | Modified at | 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. | False |
| name | Volume name | volume01 |
| servers | Attached servers | [] |
| size | Volume size | 104 |
| snapshot_id | Snapshot ID | cceed636-1f1e-4bb0-b85c-4e5b9e0bf790 |
| state | Volume state | available |
| user_id | User ID | 570907805e5447be84b618450ef52o0t |
| volume_image_metadata | Volume Image metadata | {} |
| volume_type | Volume type | SSD |
| volume_type_id | Volume type ID | c643ac35-3aec-43e6-b97a-3d6f666c5207 |