This is the multi-page printable view of this section. Click here to print.
List Volume Groups
1 - 1.3
scpcli baremetal-blockstorage volume-group list
[--limit <value>]
[--offset <value>]
[--sort <value>]
[--name <value>]
Description
Get a list of Volume Groups.
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 group name | vg-01 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
| account_id | Account id | 36827d9b643f46c2ae6bb7e63d633bfe |
| created_at | Created at | 2024-08-01T07:06:23.315Z |
| created_by | Created by | samsung-cloud-platform1@samsung.com |
| modified_at | Modified at | 2024-08-01T07:06:25.315Z |
| modified_by | Modified by | samsung-cloud-platform2@samsung.com |
| name | Volume group name | vg-01 |
| num_of_block_storages | Number of volumes | 2 |
| purpose | Volume group purpose | ORG |
| state | Current state |
2 - 1.2
scpcli baremetal-blockstorage volume-group list
[--limit <value>]
[--offset <value>]
[--sort <value>]
[--name <value>]
Description
Get a list of Volume Groups.
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 group name | vg-01 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
| account_id | Account id | 36827d9b643f46c2ae6bb7e63d633bfe |
| created_at | Created at | 2024-08-01T07:06:23.315Z |
| created_by | Created by | samsung-cloud-platform1@samsung.com |
| modified_at | Modified at | 2024-08-01T07:06:25.315Z |
| modified_by | Modified by | samsung-cloud-platform2@samsung.com |
| name | Volume group name | vg-01 |
| num_of_block_storages | Number of volumes | 2 |
| purpose | Volume group purpose | ORG |
| state | Current state |
3 - 1.1
scpcli baremetal-blockstorage volume-group list
[--limit <value>]
[--offset <value>]
[--sort <value>]
[--name <value>]
Description
Get a list of Volume Groups.
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 group name | vg-01 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
| account_id | Account id | 36827d9b643f46c2ae6bb7e63d633bfe |
| created_at | Created at | 2024-08-01T07:06:23.315Z |
| created_by | Created by | samsung-cloud-platform1@samsung.com |
| modified_at | Modified at | 2024-08-01T07:06:25.315Z |
| modified_by | Modified by | samsung-cloud-platform2@samsung.com |
| name | Volume group name | vg-01 |
| num_of_block_storages | Number of volumes | 2 |
| purpose | Volume group purpose | ORG |
| state | Current state |
4 - 1.0
scpcli baremetal-blockstorage volume-group list
[--limit <value>]
[--offset <value>]
[--sort <value>]
[--name <value>]
Description
Get a list of Volume Groups.
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 group name | vg-01 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
| account_id | Account id | 36827d9b643f46c2ae6bb7e63d633bfe |
| created_at | Created at | 2024-08-01T07:06:23.315Z |
| created_by | Created by | samsung-cloud-platform1@samsung.com |
| modified_at | Modified at | 2024-08-01T07:06:25.315Z |
| modified_by | Modified by | samsung-cloud-platform2@samsung.com |
| name | Volume group name | vg-01 |
| num_of_block_storages | Number of volumes | 2 |
| purpose | Volume group purpose | ORG |
| state | Current state |