List Volumes

1: 1.3
2: 1.2
3: 1.1
4: 1.0

1 - 1.3

scpcli baremetal-blockstorage volume list
[--limit <value>]
[--offset <value>]
[--sort <value>]
[--name <value>]
[--object_name <value>]
[--volume_group_name <value>]

Description

Get a list of Volumes.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Name	Type	Description	Example
limit optional	integer	Number to be displayed on the page	`20`
offset optional	integer	Offset	`0`
sort optional	string	Sort	`column1:asc,column2:desc`
name optional	string	Volume name	`bs-01`
object_name optional	string	Attached server name	`baremetal-server-name`
volume_group_name optional	string	Volume group name	`vg-01`

Responses

Name	Description	Example
id	id	7239779c01e3405f82bb71c7f4b55fcd
attachments	Attached server	[{‘id’: ‘d7682135392e42489948c189e29011cc’, ’name’: ‘baremetal-01’}]
created_at	Created at
created_by	Created by	samsung-cloud-platform1@samsung.com
disk_type	Disk type
has_relation	Whether relation exists	False
is_in_volume_group	Whether to belong to the volume group	False
is_snapshot_activated	Whether to activate snapshot	True
iscsi_target_ips	List of iscsi ips	{‘description’: ‘List of iscsi ips’, ’example’: [‘172.30.4.3’, ‘172.30.4.4’]}
modified_at	Modified at
modified_by	Modified by	samsung-cloud-platform2@samsung.com
name	Volume name	bs-01
purpose	Volume purpose
size_gb	Volume capacity(GB)	10
state	Current state
volume_group	Volume group

2 - 1.2

scpcli baremetal-blockstorage volume list
[--limit <value>]
[--offset <value>]
[--sort <value>]
[--name <value>]
[--object_name <value>]
[--volume_group_name <value>]

Description

Get a list of 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.2	20260531

Parameters

Name	Type	Description	Example
limit optional	integer	Number to be displayed on the page	`20`
offset optional	integer	Offset	`0`
sort optional	string	Sort	`column1:asc,column2:desc`
name optional	string	Volume name	`bs-01`
object_name optional	string	Attached server name	`baremetal-server-name`
volume_group_name optional	string	Volume group name	`vg-01`

Responses

Name	Description	Example
id	id	7239779c01e3405f82bb71c7f4b55fcd
attachments	Attached server	[{‘id’: ‘d7682135392e42489948c189e29011cc’, ’name’: ‘baremetal-01’}]
created_at	Created at
created_by	Created by	samsung-cloud-platform1@samsung.com
disk_type	Disk type
has_relation	Whether relation exists	False
is_in_volume_group	Whether to belong to the volume group	False
is_snapshot_activated	Whether to activate snapshot	True
iscsi_target_ips	List of iscsi ips	{‘description’: ‘List of iscsi ips’, ’example’: [‘172.30.4.3’, ‘172.30.4.4’]}
modified_at	Modified at
modified_by	Modified by	samsung-cloud-platform2@samsung.com
name	Volume name	bs-01
purpose	Volume purpose
size_gb	Volume capacity(GB)	10
state	Current state
volume_group	Volume group

3 - 1.1

scpcli baremetal-blockstorage volume list
[--limit <value>]
[--offset <value>]
[--sort <value>]
[--name <value>]
[--object_name <value>]
[--volume_group_name <value>]

Description

Get a list of 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	20260331

Parameters

Name	Type	Description	Example
limit optional	integer	Number to be displayed on the page	`20`
offset optional	integer	Offset	`0`
sort optional	string	Sort	`column1:asc,column2:desc`
name optional	string	Volume name	`bs-01`
object_name optional	string	Attached server name	`baremetal-server-name`
volume_group_name optional	string	Volume group name	`vg-01`

Responses

Name	Description	Example
id	id	7239779c01e3405f82bb71c7f4b55fcd
attachments	Attached server	[{‘id’: ‘d7682135392e42489948c189e29011cc’, ’name’: ‘baremetal-01’}]
created_at	Created at
created_by	Created by	samsung-cloud-platform1@samsung.com
disk_type	Disk type
has_relation	Whether relation exists	False
is_in_volume_group	Whether to belong to the volume group	False
is_snapshot_activated	Whether to activate snapshot	True
iscsi_target_ips	List of iscsi ips	{‘description’: ‘List of iscsi ips’, ’example’: [‘172.30.4.3’, ‘172.30.4.4’]}
modified_at	Modified at
modified_by	Modified by	samsung-cloud-platform2@samsung.com
name	Volume name	bs-01
purpose	Volume purpose
size_gb	Volume capacity(GB)	10
state	Current state
volume_group	Volume group

4 - 1.0

scpcli baremetal-blockstorage volume list
[--limit <value>]
[--offset <value>]
[--sort <value>]
[--name <value>]
[--object_name <value>]
[--volume_group_name <value>]

Description

Get a list of 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
limit optional	integer	Number to be displayed on the page	`20`
offset optional	integer	Offset	`0`
sort optional	string	Sort	`column1:asc,column2:desc`
name optional	string	Volume name	`bs-01`
object_name optional	string	Attached server name	`baremetal-server-name`
volume_group_name optional	string	Volume group name	`vg-01`

Responses

Name	Description	Example
id	id	7239779c01e3405f82bb71c7f4b55fcd
attachments	Attached server	[{‘id’: ‘d7682135392e42489948c189e29011cc’, ’name’: ‘baremetal-01’}]
created_at	Created at
created_by	Created by	samsung-cloud-platform1@samsung.com
disk_type	Disk type
has_relation	Whether relation exists	False
is_in_volume_group	Whether to belong to the volume group	False
is_snapshot_activated	Whether to activate snapshot	True
iscsi_target_ips	List of iscsi ips	{‘description’: ‘List of iscsi ips’, ’example’: [‘172.30.4.3’, ‘172.30.4.4’]}
modified_at	Modified at
modified_by	Modified by	samsung-cloud-platform2@samsung.com
name	Volume name	bs-01
purpose	Volume purpose
size_gb	Volume capacity(GB)	10
state	Current state
volume_group	Volume group