Block Storage(BM)
Overview
Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.
This guide provides a brief description of Block Storage(BM) service and how to call CLI.
Version
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Status | Not Before |
|---|
| 1.3 | CURRENT | - |
| 1.2 | DEPRECATED | 20260531 |
| 1.1 | DEPRECATED | 20260331 |
| 1.0 | DEPRECATED | 20251231 |
1 - CLIs
1.1 - Add Volume Group Member on Volume Group
1.1.1 - 1.3
scpcli baremetal-blockstorage volume-group member add
--volume_group_id <value>
--volume_ids <value>
Description
Add Volume Group Member on Volume Group.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
volume_group_id required | string | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
volume_ids required | array | List of volume(Block Storage) id | 13666d6c32d4456e8421f7768d0bf225 |
1.1.2 - 1.2
scpcli baremetal-blockstorage volume-group member add
--volume_group_id <value>
--volume_ids <value>
Description
Add Volume Group Member on Volume Group.
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 |
|---|
volume_group_id required | string | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
volume_ids required | array | List of volume(Block Storage) id | 13666d6c32d4456e8421f7768d0bf225 |
1.1.3 - 1.1
scpcli baremetal-blockstorage volume-group member add
--volume_group_id <value>
--volume_ids <value>
Description
Add Volume Group Member on Volume Group.
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 |
|---|
volume_group_id required | string | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
volume_ids required | array | List of volume(Block Storage) id | 13666d6c32d4456e8421f7768d0bf225 |
1.1.4 - 1.0
scpcli baremetal-blockstorage volume-group member add
--volume_group_id <value>
--volume_ids <value>
Description
Add Volume Group Member on Volume Group.
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_group_id required | string | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
volume_ids required | array | List of volume(Block Storage) id | 13666d6c32d4456e8421f7768d0bf225 |
1.2 - Attach Volume
1.2.1 - 1.3
scpcli baremetal-blockstorage volume attachment create
--volume_id <value>
--attachments <value>
Description
Attach Volume to servers.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
volume_id required | string | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
attachments required | array | List of server id and type | '{"object_id": "83c3c73d457345e3829ee6d5557c0016", "object_type": "BM"}' |
Responses
| Name | Description | Example |
|---|
| object_id | Object id | 83c3c73d457345e3829ee6d5557c0016 |
| object_type | Object type | |
1.2.2 - 1.2
scpcli baremetal-blockstorage volume attachment create
--volume_id <value>
--attachments <value>
Description
Attach Volume to servers.
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 |
|---|
volume_id required | string | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
attachments required | array | List of server id and type | '{"object_id": "83c3c73d457345e3829ee6d5557c0016", "object_type": "BM"}' |
Responses
| Name | Description | Example |
|---|
| object_id | Object id | 83c3c73d457345e3829ee6d5557c0016 |
| object_type | Object type | |
1.2.3 - 1.1
scpcli baremetal-blockstorage volume attachment create
--volume_id <value>
--attachments <value>
Description
Attach Volume to servers.
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 |
|---|
volume_id required | string | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
attachments required | array | List of server id and type | '{"object_id": "83c3c73d457345e3829ee6d5557c0016", "object_type": "BM"}' |
Responses
| Name | Description | Example |
|---|
| result | Volume detail | |
1.2.4 - 1.0
scpcli baremetal-blockstorage volume attachment create
--volume_id <value>
--attachments <value>
Description
Attach Volume to servers.
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 | 92cd16fe8ebc4f73832513a172bf0000 |
attachments required | array | List of server id and type | '{"object_id": "83c3c73d457345e3829ee6d5557c0016", "object_type": "BM"}' |
Responses
| Name | Description | Example |
|---|
| result | Volume detail | |
1.3 - Create Volume
1.3.1 - 1.3
scpcli baremetal-blockstorage volume create
--throughput <value>
--iops <value>
--size_gb <value>
--name <value>
--disk_type <value>
--attachments <value>
[--tags <value>]
Description
Create Volume.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
throughput required | integer | Enter the value between at least 250MB/s and up to 1,000MB/s. | 250 |
iops required | integer | Enter the value between at least 5,000 IOPS and up to 20,000 IOPS. | 5000 |
size_gb required | integer | Volume capacity(GB) | 10 |
name required | string | Volume name | bs-01 |
disk_type required | string | Disk type | - |
attachments required | array | List of server id and type | '{"object_id": "83c3c73d457345e3829ee6d5557c0016", "object_type": "BM"}' |
tags optional | array | Tags | '{"key": "my_tag_1", "value": "my_value_1"}' |
Responses
| Name | Description | Example |
|---|
| request_id | Request id | req-0006064c-c008-458c-8977-19671c6b32d4 |
| resource_id | Resource id | 8bf55e738d4e44b5a21dbe133a42ecbe |
1.3.2 - 1.2
scpcli baremetal-blockstorage volume create
--throughput <value>
--iops <value>
--size_gb <value>
--name <value>
--disk_type <value>
--attachments <value>
[--tags <value>]
Description
Create Volume.
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 |
|---|
throughput required | integer | Enter the value between at least 250MB/s and up to 1,000MB/s. | 250 |
iops required | integer | Enter the value between at least 5,000 IOPS and up to 20,000 IOPS. | 5000 |
size_gb required | integer | Volume capacity(GB) | 10 |
name required | string | Volume name | bs-01 |
disk_type required | string | Disk type | - |
attachments required | array | List of server id and type | '{"object_id": "83c3c73d457345e3829ee6d5557c0016", "object_type": "BM"}' |
tags optional | array | Tags | '{"key": "my_tag_1", "value": "my_value_1"}' |
Responses
| Name | Description | Example |
|---|
| request_id | Request id | req-0006064c-c008-458c-8977-19671c6b32d4 |
| resource_id | Resource id | 8bf55e738d4e44b5a21dbe133a42ecbe |
1.3.3 - 1.1
scpcli baremetal-blockstorage volume create
--size_gb <value>
--name <value>
--disk_type <value>
--attachments <value>
[--tags <value>]
Description
Create Volume.
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 |
|---|
size_gb required | integer | Volume capacity(GB) | 10 |
name required | string | Volume name | bs-01 |
disk_type required | string | Disk type | - |
attachments required | array | List of server id and type | '{"object_id": "83c3c73d457345e3829ee6d5557c0016", "object_type": "BM"}' |
tags optional | array | Tags | '{"key": "my_tag_1", "value": "my_value_1"}' |
Responses
| Name | Description | Example |
|---|
| request_id | Request id | req-0006064c-c008-458c-8977-19671c6b32d4 |
| resource_id | Resource id | 8bf55e738d4e44b5a21dbe133a42ecbe |
1.3.4 - 1.0
scpcli baremetal-blockstorage volume create
--size_gb <value>
--name <value>
--disk_type <value>
--attachments <value>
[--tags <value>]
Description
Create Volume.
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 |
|---|
size_gb required | integer | Volume capacity(GB) | 10 |
name required | string | Volume name | bs-01 |
disk_type required | string | Disk type | - |
attachments required | array | List of server id and type | '{"object_id": "83c3c73d457345e3829ee6d5557c0016", "object_type": "BM"}' |
tags optional | array | Tags | '{"key": "my_tag_1", "value": "my_value_1"}' |
Responses
| Name | Description | Example |
|---|
| request_id | Request id | req-0006064c-c008-458c-8977-19671c6b32d4 |
| resource_id | Resource id | 8bf55e738d4e44b5a21dbe133a42ecbe |
1.4 - Create Volume Group
1.4.1 - 1.3
scpcli baremetal-blockstorage volume-group create
--volume_ids <value>
--name <value>
[--tags <value>]
Description
Create Volume Group
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
volume_ids required | array | List of volume(Block Storage) id to add | 17e0b4fd27784dfb843440ec08bdd148 |
name required | string | Volume group name | vg-01 |
tags optional | array | Tags | '{"key": "my_tag_1", "value": "my_value_1"}' |
Responses
| Name | Description | Example |
|---|
| request_id | Request id | req-0006064c-c008-458c-8977-19671c6b32d4 |
| resource_id | Resource id | 8bf55e738d4e44b5a21dbe133a42ecbe |
1.4.2 - 1.2
scpcli baremetal-blockstorage volume-group create
--volume_ids <value>
--name <value>
[--tags <value>]
Description
Create Volume Group
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 |
|---|
volume_ids required | array | List of volume(Block Storage) id to add | 17e0b4fd27784dfb843440ec08bdd148 |
name required | string | Volume group name | vg-01 |
tags optional | array | Tags | '{"key": "my_tag_1", "value": "my_value_1"}' |
Responses
| Name | Description | Example |
|---|
| request_id | Request id | req-0006064c-c008-458c-8977-19671c6b32d4 |
| resource_id | Resource id | 8bf55e738d4e44b5a21dbe133a42ecbe |
1.4.3 - 1.1
scpcli baremetal-blockstorage volume-group create
--volume_ids <value>
--name <value>
[--tags <value>]
Description
Create Volume Group
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 |
|---|
volume_ids required | array | List of volume(Block Storage) id to add | 17e0b4fd27784dfb843440ec08bdd148 |
name required | string | Volume group name | vg-01 |
tags optional | array | Tags | '{"key": "my_tag_1", "value": "my_value_1"}' |
Responses
| Name | Description | Example |
|---|
| request_id | Request id | req-0006064c-c008-458c-8977-19671c6b32d4 |
| resource_id | Resource id | 8bf55e738d4e44b5a21dbe133a42ecbe |
1.4.4 - 1.0
scpcli baremetal-blockstorage volume-group create
--volume_ids <value>
--name <value>
[--tags <value>]
Description
Create Volume Group
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_ids required | array | List of volume(Block Storage) id to add | 17e0b4fd27784dfb843440ec08bdd148 |
name required | string | Volume group name | vg-01 |
tags optional | array | Tags | '{"key": "my_tag_1", "value": "my_value_1"}' |
Responses
| Name | Description | Example |
|---|
| request_id | Request id | req-0006064c-c008-458c-8977-19671c6b32d4 |
| resource_id | Resource id | 8bf55e738d4e44b5a21dbe133a42ecbe |
1.5 - Create Volume Group Recovery
1.5.1 - 1.3
scpcli baremetal-blockstorage volume-group recovery create
--volume_group_id <value>
--snapshot_id <value>
--block_storage_name_prefix <value>
Description
Create Volume Group Recovery.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
volume_group_id required | string | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
snapshot_id required | string | Snapshot id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
block_storage_name_prefix required | string | Block Storage name prefix | prefix- |
Responses
| Name | Description | Example |
|---|
| request_id | Request id | req-0006064c-c008-458c-8977-19671c6b32d4 |
| resource_id | Resource id | 8bf55e738d4e44b5a21dbe133a42ecbe |
1.5.2 - 1.2
scpcli baremetal-blockstorage volume-group recovery create
--volume_group_id <value>
--snapshot_id <value>
--block_storage_name_prefix <value>
Description
Create Volume Group Recovery.
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 |
|---|
volume_group_id required | string | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
snapshot_id required | string | Snapshot id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
block_storage_name_prefix required | string | Block Storage name prefix | prefix- |
Responses
| Name | Description | Example |
|---|
| request_id | Request id | req-0006064c-c008-458c-8977-19671c6b32d4 |
| resource_id | Resource id | 8bf55e738d4e44b5a21dbe133a42ecbe |
1.5.3 - 1.1
scpcli baremetal-blockstorage volume-group recovery create
--volume_group_id <value>
--snapshot_id <value>
--block_storage_name_prefix <value>
Description
Create Volume Group Recovery.
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 |
|---|
volume_group_id required | string | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
snapshot_id required | string | Snapshot id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
block_storage_name_prefix required | string | Block Storage name prefix | prefix- |
Responses
| Name | Description | Example |
|---|
| request_id | Request id | req-0006064c-c008-458c-8977-19671c6b32d4 |
| resource_id | Resource id | 8bf55e738d4e44b5a21dbe133a42ecbe |
1.6 - Create Volume Group Replication
1.6.1 - 1.3
scpcli baremetal-blockstorage volume-group replication create
--volume_group_id <value>
--replication_volume_name_prefix <value>
--region <value>
--name <value>
--cycle <value>
Description
Create Volume Group Replication.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
volume_group_id required | string | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
replication_volume_name_prefix required | string | Replication volume name prefix | dr |
region required | string | Region | kr-west1 |
name required | string | Replication volume group name | replica-vg-01 |
cycle required | string | Replication cycle | - |
Responses
| Name | Description | Example |
|---|
| request_id | Request id | req-0006064c-c008-458c-8977-19671c6b32d4 |
| resource_id | Resource id | 8bf55e738d4e44b5a21dbe133a42ecbe |
1.6.2 - 1.2
scpcli baremetal-blockstorage volume-group replication create
--volume_group_id <value>
--replication_volume_name_prefix <value>
--region <value>
--name <value>
--cycle <value>
Description
Create Volume Group Replication.
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 |
|---|
volume_group_id required | string | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
replication_volume_name_prefix required | string | Replication volume name prefix | dr |
region required | string | Region | kr-west1 |
name required | string | Replication volume group name | replica-vg-01 |
cycle required | string | Replication cycle | - |
Responses
| Name | Description | Example |
|---|
| request_id | Request id | req-0006064c-c008-458c-8977-19671c6b32d4 |
| resource_id | Resource id | 8bf55e738d4e44b5a21dbe133a42ecbe |
1.6.3 - 1.1
scpcli baremetal-blockstorage volume-group replication create
--volume_group_id <value>
--replication_volume_name_prefix <value>
--region <value>
--name <value>
--cycle <value>
Description
Create Volume Group Replication.
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 |
|---|
volume_group_id required | string | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
replication_volume_name_prefix required | string | Replication volume name prefix | dr |
region required | string | Region | kr-west1 |
name required | string | Replication volume group name | replica-vg-01 |
cycle required | string | Replication cycle | - |
Responses
| Name | Description | Example |
|---|
| request_id | Request id | req-0006064c-c008-458c-8977-19671c6b32d4 |
| resource_id | Resource id | 8bf55e738d4e44b5a21dbe133a42ecbe |
1.6.4 - 1.0
scpcli baremetal-blockstorage volume-group replication create
--volume_group_id <value>
--replication_volume_name_prefix <value>
--region <value>
--name <value>
--cycle <value>
Description
Create Volume Group Replication.
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_group_id required | string | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
replication_volume_name_prefix required | string | Replication volume name prefix | dr |
region required | string | Region | kr-west1 |
name required | string | Replication volume group name | replica-vg-01 |
cycle required | string | Replication cycle | - |
Responses
| Name | Description | Example |
|---|
| request_id | Request id | req-0006064c-c008-458c-8977-19671c6b32d4 |
| resource_id | Resource id | 8bf55e738d4e44b5a21dbe133a42ecbe |
1.7 - Create Volume Group Snapshot
1.7.1 - 1.3
scpcli baremetal-blockstorage volume-group snapshot create
--volume_group_id <value>
Description
Create Volume Group Snapshot
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
volume_group_id required | string | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
Responses
| Name | Description | Example |
|---|
| account_id | Account id | 36827d9b643f46c2ae6bb7e63d633bfe |
| snapshot_id | Snapshot id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
| snapshot_name | Snapshot name | vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932 |
| volume_group_id | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
1.7.2 - 1.2
scpcli baremetal-blockstorage volume-group snapshot create
--volume_group_id <value>
Description
Create Volume Group Snapshot
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 |
|---|
volume_group_id required | string | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
Responses
| Name | Description | Example |
|---|
| account_id | Account id | 36827d9b643f46c2ae6bb7e63d633bfe |
| snapshot_id | Snapshot id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
| snapshot_name | Snapshot name | vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932 |
| volume_group_id | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
1.7.3 - 1.1
scpcli baremetal-blockstorage volume-group snapshot create
--volume_group_id <value>
Description
Create Volume Group Snapshot
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 |
|---|
volume_group_id required | string | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
Responses
| Name | Description | Example |
|---|
| account_id | Account id | 36827d9b643f46c2ae6bb7e63d633bfe |
| snapshot_id | Snapshot id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
| snapshot_name | Snapshot name | vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932 |
| volume_group_id | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
1.7.4 - 1.0
scpcli baremetal-blockstorage volume-group snapshot create
--volume_group_id <value>
Description
Create Volume Group Snapshot
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_group_id required | string | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
Responses
| Name | Description | Example |
|---|
| account_id | Account id | 36827d9b643f46c2ae6bb7e63d633bfe |
| snapshot_id | Snapshot id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
| snapshot_name | Snapshot name | vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932 |
| volume_group_id | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
1.8 - Create Volume Group Snapshot Schedule
1.8.1 - 1.3
scpcli baremetal-blockstorage volume-group snapshot-schedule create
--volume_group_id <value>
--hour <value>
[--day_of_week <value>]
Description
Create Volume Group Snapshot Schedule.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
volume_group_id required | string | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
hour required | integer | Hour | 18 |
day_of_week optional | string | Day of week(If this field is excluded, the schedule frequency is set to DAILY.) | - |
Responses
| Name | Description | Example |
|---|
| day_of_week | Day of week | |
| frequency | Frequency DAILY | WEEKLY |
| hour | Hour | 18 |
| volume_group_id | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
1.8.2 - 1.2
scpcli baremetal-blockstorage volume-group snapshot-schedule create
--volume_group_id <value>
--hour <value>
[--day_of_week <value>]
Description
Create Volume Group Snapshot Schedule.
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 |
|---|
volume_group_id required | string | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
hour required | integer | Hour | 18 |
day_of_week optional | string | Day of week(If this field is excluded, the schedule frequency is set to DAILY.) | - |
Responses
| Name | Description | Example |
|---|
| day_of_week | Day of week | |
| frequency | Frequency DAILY | WEEKLY |
| hour | Hour | 18 |
| volume_group_id | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
1.8.3 - 1.1
scpcli baremetal-blockstorage volume-group snapshot-schedule create
--volume_group_id <value>
--hour <value>
[--day_of_week <value>]
Description
Create Volume Group Snapshot Schedule.
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 |
|---|
volume_group_id required | string | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
hour required | integer | Hour | 18 |
day_of_week optional | string | Day of week(If this field is excluded, the schedule frequency is set to DAILY.) | - |
Responses
| Name | Description | Example |
|---|
| day_of_week | Day of week | |
| frequency | Frequency DAILY | WEEKLY |
| hour | Hour | 18 |
| volume_group_id | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
1.8.4 - 1.0
scpcli baremetal-blockstorage volume-group snapshot-schedule create
--volume_group_id <value>
--hour <value>
[--day_of_week <value>]
Description
Create Volume Group Snapshot Schedule.
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_group_id required | string | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
hour required | integer | Hour | 18 |
day_of_week optional | string | Day of week(If this field is excluded, the schedule frequency is set to DAILY.) | - |
Responses
| Name | Description | Example |
|---|
| day_of_week | Day of week | |
| frequency | Frequency DAILY | WEEKLY |
| hour | Hour | 18 |
| volume_group_id | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
1.9 - Create Volume Recovery
1.9.1 - 1.3
scpcli baremetal-blockstorage volume recovery create
--volume_id <value>
--snapshot_id <value>
--name <value>
Description
Create Volume Recovery.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
volume_id required | string | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
snapshot_id required | string | Snapshot id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
name required | string | Recovery volume name | recovery-volume |
Responses
| Name | Description | Example |
|---|
| request_id | Request id | req-0006064c-c008-458c-8977-19671c6b32d4 |
| resource_id | Resource id | 8bf55e738d4e44b5a21dbe133a42ecbe |
1.9.2 - 1.2
scpcli baremetal-blockstorage volume recovery create
--volume_id <value>
--snapshot_id <value>
--name <value>
Description
Create Volume Recovery.
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 |
|---|
volume_id required | string | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
snapshot_id required | string | Snapshot id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
name required | string | Recovery volume name | recovery-volume |
Responses
| Name | Description | Example |
|---|
| request_id | Request id | req-0006064c-c008-458c-8977-19671c6b32d4 |
| resource_id | Resource id | 8bf55e738d4e44b5a21dbe133a42ecbe |
1.9.3 - 1.1
scpcli baremetal-blockstorage volume recovery create
--volume_id <value>
--snapshot_id <value>
--name <value>
Description
Create Volume Recovery.
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 |
|---|
volume_id required | string | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
snapshot_id required | string | Snapshot id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
name required | string | Recovery volume name | recovery-volume |
Responses
| Name | Description | Example |
|---|
| request_id | Request id | req-0006064c-c008-458c-8977-19671c6b32d4 |
| resource_id | Resource id | 8bf55e738d4e44b5a21dbe133a42ecbe |
1.10 - Create Volume Replication
1.10.1 - 1.3
scpcli baremetal-blockstorage volume replication create
--volume_id <value>
--region <value>
--name <value>
--cycle <value>
Description
Create Volume Replication.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
volume_id required | string | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
region required | string | Region | kr-west1 |
name required | string | Replication volume name | replica-bs-01 |
cycle required | string | Replication cycle | - |
Responses
| Name | Description | Example |
|---|
| request_id | Request id | req-0006064c-c008-458c-8977-19671c6b32d4 |
| resource_id | Resource id | 8bf55e738d4e44b5a21dbe133a42ecbe |
1.10.2 - 1.2
scpcli baremetal-blockstorage volume replication create
--volume_id <value>
--region <value>
--name <value>
--cycle <value>
Description
Create Volume Replication.
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 |
|---|
volume_id required | string | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
region required | string | Region | kr-west1 |
name required | string | Replication volume name | replica-bs-01 |
cycle required | string | Replication cycle | - |
Responses
| Name | Description | Example |
|---|
| request_id | Request id | req-0006064c-c008-458c-8977-19671c6b32d4 |
| resource_id | Resource id | 8bf55e738d4e44b5a21dbe133a42ecbe |
1.10.3 - 1.1
scpcli baremetal-blockstorage volume replication create
--volume_id <value>
--region <value>
--name <value>
--cycle <value>
Description
Create Volume Replication.
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 |
|---|
volume_id required | string | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
region required | string | Region | kr-west1 |
name required | string | Replication volume name | replica-bs-01 |
cycle required | string | Replication cycle | - |
Responses
| Name | Description | Example |
|---|
| request_id | Request id | req-0006064c-c008-458c-8977-19671c6b32d4 |
| resource_id | Resource id | 8bf55e738d4e44b5a21dbe133a42ecbe |
1.10.4 - 1.0
scpcli baremetal-blockstorage volume replication create
--volume_id <value>
--region <value>
--name <value>
--cycle <value>
Description
Create Volume Replication.
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 | 92cd16fe8ebc4f73832513a172bf0000 |
region required | string | Region | kr-west1 |
name required | string | Replication volume name | replica-bs-01 |
cycle required | string | Replication cycle | - |
Responses
| Name | Description | Example |
|---|
| request_id | Request id | req-0006064c-c008-458c-8977-19671c6b32d4 |
| resource_id | Resource id | 8bf55e738d4e44b5a21dbe133a42ecbe |
1.11 - Create Volume Snapshot
1.11.1 - 1.3
scpcli baremetal-blockstorage volume snapshot create
--volume_id <value>
Description
Create Volume snapshot.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
volume_id required | string | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
Responses
| Name | Description | Example |
|---|
| account_id | Account id | 36827d9b643f46c2ae6bb7e63d633bfe |
| snapshot_id | Snapshot id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
| snapshot_name | Snapshot name | vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932 |
| volume_id | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
1.11.2 - 1.2
scpcli baremetal-blockstorage volume snapshot create
--volume_id <value>
Description
Create Volume snapshot.
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 |
|---|
volume_id required | string | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
Responses
| Name | Description | Example |
|---|
| account_id | Account id | 36827d9b643f46c2ae6bb7e63d633bfe |
| snapshot_id | Snapshot id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
| snapshot_name | Snapshot name | vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932 |
| volume_id | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
1.11.3 - 1.1
scpcli baremetal-blockstorage volume snapshot create
--volume_id <value>
Description
Create Volume snapshot.
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 |
|---|
volume_id required | string | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
Responses
| Name | Description | Example |
|---|
| account_id | Account id | 36827d9b643f46c2ae6bb7e63d633bfe |
| snapshot_id | Snapshot id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
| snapshot_name | Snapshot name | vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932 |
| volume_id | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
1.11.4 - 1.0
scpcli baremetal-blockstorage volume snapshot create
--volume_id <value>
Description
Create Volume snapshot.
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 | 92cd16fe8ebc4f73832513a172bf0000 |
Responses
| Name | Description | Example |
|---|
| account_id | Account id | 36827d9b643f46c2ae6bb7e63d633bfe |
| snapshot_id | Snapshot id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
| snapshot_name | Snapshot name | vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932 |
| volume_id | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
1.12 - Create Volume Snapshot Rate
1.12.1 - 1.3
scpcli baremetal-blockstorage volume snapshot-rate create
--volume_id <value>
--snapshot_rate <value>
Description
Create Volume snapshot rate.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
volume_id required | string | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
snapshot_rate required | integer | Snapshot rate | 100 |
Responses
| Name | Description | Example |
|---|
| is_snapshot_activated | Whether to activate snapshot | True |
| snapshot_rate | Snapshot rate | 100 |
| volume_id | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
1.12.2 - 1.2
scpcli baremetal-blockstorage volume snapshot-rate create
--volume_id <value>
--snapshot_rate <value>
Description
Create Volume snapshot rate.
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 |
|---|
volume_id required | string | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
snapshot_rate required | integer | Snapshot rate | 100 |
Responses
| Name | Description | Example |
|---|
| is_snapshot_activated | Whether to activate snapshot | True |
| snapshot_rate | Snapshot rate | 100 |
| volume_id | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
1.12.3 - 1.1
scpcli baremetal-blockstorage volume snapshot-rate create
--volume_id <value>
--snapshot_rate <value>
Description
Create Volume snapshot rate.
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 |
|---|
volume_id required | string | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
snapshot_rate required | integer | Snapshot rate | 100 |
Responses
| Name | Description | Example |
|---|
| is_snapshot_activated | Whether to activate snapshot | True |
| snapshot_rate | Snapshot rate | 100 |
| volume_id | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
1.12.4 - 1.0
scpcli baremetal-blockstorage volume snapshot-rate create
--volume_id <value>
--snapshot_rate <value>
Description
Create Volume snapshot rate.
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 | 92cd16fe8ebc4f73832513a172bf0000 |
snapshot_rate required | integer | Snapshot rate | 100 |
Responses
| Name | Description | Example |
|---|
| is_snapshot_activated | Whether to activate snapshot | True |
| snapshot_rate | Snapshot rate | 100 |
| volume_id | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
1.13 - Create Volume Snapshot Schedule
1.13.1 - 1.3
scpcli baremetal-blockstorage volume snapshot-schedule create
--volume_id <value>
--hour <value>
[--day_of_week <value>]
Description
Create Volume snapshot schedule.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
volume_id required | string | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
hour required | integer | Hour | 18 |
day_of_week optional | string | Day of week(If this field is excluded, the schedule frequency is set to DAILY.) | - |
Responses
| Name | Description | Example |
|---|
| day_of_week | Day of week | |
| frequency | Frequency DAILY | WEEKLY |
| hour | Hour | 18 |
| volume_id | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
1.13.2 - 1.2
scpcli baremetal-blockstorage volume snapshot-schedule create
--volume_id <value>
--hour <value>
[--day_of_week <value>]
Description
Create Volume snapshot schedule.
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 |
|---|
volume_id required | string | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
hour required | integer | Hour | 18 |
day_of_week optional | string | Day of week(If this field is excluded, the schedule frequency is set to DAILY.) | - |
Responses
| Name | Description | Example |
|---|
| day_of_week | Day of week | |
| frequency | Frequency DAILY | WEEKLY |
| hour | Hour | 18 |
| volume_id | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
1.13.3 - 1.1
scpcli baremetal-blockstorage volume snapshot-schedule create
--volume_id <value>
--hour <value>
[--day_of_week <value>]
Description
Create Volume snapshot schedule.
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 |
|---|
volume_id required | string | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
hour required | integer | Hour | 18 |
day_of_week optional | string | Day of week(If this field is excluded, the schedule frequency is set to DAILY.) | - |
Responses
| Name | Description | Example |
|---|
| day_of_week | Day of week | |
| frequency | Frequency DAILY | WEEKLY |
| hour | Hour | 18 |
| volume_id | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
1.13.4 - 1.0
scpcli baremetal-blockstorage volume snapshot-schedule create
--volume_id <value>
--hour <value>
[--day_of_week <value>]
Description
Create Volume snapshot schedule.
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 | 92cd16fe8ebc4f73832513a172bf0000 |
hour required | integer | Hour | 18 |
day_of_week optional | string | Day of week(If this field is excluded, the schedule frequency is set to DAILY.) | - |
Responses
| Name | Description | Example |
|---|
| day_of_week | Day of week | |
| frequency | Frequency DAILY | WEEKLY |
| hour | Hour | 18 |
| volume_id | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
1.14 - Delete Volume
1.14.1 - 1.3
scpcli baremetal-blockstorage volume delete
--volume_id <value>
Description
Delete Volume.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
volume_id required | string | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
1.14.2 - 1.2
scpcli baremetal-blockstorage volume delete
--volume_id <value>
Description
Delete Volume.
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 |
|---|
volume_id required | string | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
1.14.3 - 1.1
scpcli baremetal-blockstorage volume delete
--volume_id <value>
Description
Delete Volume.
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 |
|---|
volume_id required | string | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
1.14.4 - 1.0
scpcli baremetal-blockstorage volume delete
--volume_id <value>
Description
Delete Volume.
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 | 92cd16fe8ebc4f73832513a172bf0000 |
1.15 - Delete Volume Group Replication
1.15.1 - 1.3
scpcli baremetal-blockstorage volume-group replication delete
--volume_group_id <value>
Description
Delete Volume Group Replication.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
volume_group_id required | string | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
1.15.2 - 1.2
scpcli baremetal-blockstorage volume-group replication delete
--volume_group_id <value>
Description
Delete Volume Group Replication.
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 |
|---|
volume_group_id required | string | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
1.15.3 - 1.1
scpcli baremetal-blockstorage volume-group replication delete
--volume_group_id <value>
Description
Delete Volume Group Replication.
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 |
|---|
volume_group_id required | string | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
1.15.4 - 1.0
scpcli baremetal-blockstorage volume-group replication delete
--volume_group_id <value>
Description
Delete Volume Group Replication.
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_group_id required | string | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
1.16 - Delete Volume Group Snapshot
1.16.1 - 1.3
scpcli baremetal-blockstorage volume-group snapshot delete
--snapshot_id <value>
--volume_group_id <value>
Description
Delete Volume Group snapshot.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
snapshot_id required | string | Snapshot id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
volume_group_id required | string | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
1.16.2 - 1.2
scpcli baremetal-blockstorage volume-group snapshot delete
--snapshot_id <value>
--volume_group_id <value>
Description
Delete Volume Group snapshot.
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 |
|---|
snapshot_id required | string | Snapshot id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
volume_group_id required | string | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
1.16.3 - 1.1
scpcli baremetal-blockstorage volume-group snapshot delete
--snapshot_id <value>
--volume_group_id <value>
Description
Delete Volume Group snapshot.
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 |
|---|
snapshot_id required | string | Snapshot id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
volume_group_id required | string | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
1.16.4 - 1.0
scpcli baremetal-blockstorage volume-group snapshot delete
--snapshot_id <value>
--volume_group_id <value>
Description
Delete Volume Group snapshot.
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 |
|---|
snapshot_id required | string | Snapshot id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
volume_group_id required | string | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
1.17 - Delete Volume Group Snapshot Schedule
1.17.1 - 1.3
scpcli baremetal-blockstorage volume-group snapshot-schedule delete
--volume_group_id <value>
Description
Delete Volume Group Snapshot Schedule.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
volume_group_id required | string | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
1.17.2 - 1.2
scpcli baremetal-blockstorage volume-group snapshot-schedule delete
--volume_group_id <value>
Description
Delete Volume Group Snapshot Schedule.
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 |
|---|
volume_group_id required | string | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
1.17.3 - 1.1
scpcli baremetal-blockstorage volume-group snapshot-schedule delete
--volume_group_id <value>
Description
Delete Volume Group Snapshot Schedule.
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 |
|---|
volume_group_id required | string | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
1.17.4 - 1.0
scpcli baremetal-blockstorage volume-group snapshot-schedule delete
--volume_group_id <value>
Description
Delete Volume Group Snapshot Schedule.
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_group_id required | string | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
1.18 - Delete Volume Replication
1.18.1 - 1.3
scpcli baremetal-blockstorage volume replication delete
--volume_id <value>
Description
Delete Volume Replication.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
volume_id required | string | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
1.18.2 - 1.2
scpcli baremetal-blockstorage volume replication delete
--volume_id <value>
Description
Delete Volume Replication.
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 |
|---|
volume_id required | string | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
1.18.3 - 1.1
scpcli baremetal-blockstorage volume replication delete
--volume_id <value>
Description
Delete Volume Replication.
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 |
|---|
volume_id required | string | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
1.18.4 - 1.0
scpcli baremetal-blockstorage volume replication delete
--volume_id <value>
Description
Delete Volume Replication.
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 | 92cd16fe8ebc4f73832513a172bf0000 |
1.19 - Delete Volume Snapshot
1.19.1 - 1.3
scpcli baremetal-blockstorage volume snapshot delete
--snapshot_id <value>
--volume_id <value>
Description
Delete Volume snapshot.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
snapshot_id required | string | Snapshot id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
volume_id required | string | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
1.19.2 - 1.2
scpcli baremetal-blockstorage volume snapshot delete
--snapshot_id <value>
--volume_id <value>
Description
Delete Volume snapshot.
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 |
|---|
snapshot_id required | string | Snapshot id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
volume_id required | string | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
1.19.3 - 1.1
scpcli baremetal-blockstorage volume snapshot delete
--snapshot_id <value>
--volume_id <value>
Description
Delete Volume snapshot.
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 |
|---|
snapshot_id required | string | Snapshot id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
volume_id required | string | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
1.19.4 - 1.0
scpcli baremetal-blockstorage volume snapshot delete
--snapshot_id <value>
--volume_id <value>
Description
Delete Volume snapshot.
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 |
|---|
snapshot_id required | string | Snapshot id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
volume_id required | string | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
1.20 - Delete Volume Snapshot Rate
1.20.1 - 1.3
scpcli baremetal-blockstorage volume snapshot-rate delete
--volume_id <value>
Description
Delete Volume snapshot rate.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
volume_id required | string | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
1.20.2 - 1.2
scpcli baremetal-blockstorage volume snapshot-rate delete
--volume_id <value>
Description
Delete Volume snapshot rate.
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 |
|---|
volume_id required | string | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
1.20.3 - 1.1
scpcli baremetal-blockstorage volume snapshot-rate delete
--volume_id <value>
Description
Delete Volume snapshot rate.
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 |
|---|
volume_id required | string | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
1.20.4 - 1.0
scpcli baremetal-blockstorage volume snapshot-rate delete
--volume_id <value>
Description
Delete Volume snapshot rate.
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 | 92cd16fe8ebc4f73832513a172bf0000 |
1.21 - Delete Volume Snapshot Schedule
1.21.1 - 1.3
scpcli baremetal-blockstorage volume snapshot-schedule delete
--volume_id <value>
Description
Delete Volume snapshot schedule.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
volume_id required | string | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
1.21.2 - 1.2
scpcli baremetal-blockstorage volume snapshot-schedule delete
--volume_id <value>
Description
Delete Volume snapshot schedule.
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 |
|---|
volume_id required | string | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
1.21.3 - 1.1
scpcli baremetal-blockstorage volume snapshot-schedule delete
--volume_id <value>
Description
Delete Volume snapshot schedule.
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 |
|---|
volume_id required | string | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
1.21.4 - 1.0
scpcli baremetal-blockstorage volume snapshot-schedule delete
--volume_id <value>
Description
Delete Volume snapshot schedule.
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 | 92cd16fe8ebc4f73832513a172bf0000 |
1.22 - Detach Volume
1.22.1 - 1.3
scpcli baremetal-blockstorage volume attachment delete
--volume_id <value>
--attachments <value>
Description
Detach Volume from servers.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
volume_id required | string | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
attachments required | array | List of object id to detach | - |
1.22.2 - 1.2
scpcli baremetal-blockstorage volume attachment delete
--volume_id <value>
--attachments <value>
Description
Detach Volume from servers.
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 |
|---|
volume_id required | string | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
attachments required | array | List of object id to detach | - |
1.22.3 - 1.1
scpcli baremetal-blockstorage volume attachment delete
--volume_id <value>
--attachments <value>
Description
Detach Volume from servers.
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 |
|---|
volume_id required | string | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
attachments required | array | List of object id to detach | - |
1.22.4 - 1.0
scpcli baremetal-blockstorage volume attachment delete
--volume_id <value>
--attachments <value>
Description
Detach Volume from servers.
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 | 92cd16fe8ebc4f73832513a172bf0000 |
attachments required | array | List of object id to detach | - |
1.23 - List Volume Group Snapshots
1.23.1 - 1.3
scpcli baremetal-blockstorage volume-group snapshot list
--volume_group_id <value>
Description
Get a list of Volume Group snapshots.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
volume_group_id required | string | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
Responses
| Name | Description | Example |
|---|
| created_dt | Created dt | 2024-08-01T07:07:23.315Z |
| snapshot_id | Snapshot id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
| snapshot_name | Snapshot name | vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932 |
1.23.2 - 1.2
scpcli baremetal-blockstorage volume-group snapshot list
--volume_group_id <value>
Description
Get a list of Volume Group snapshots.
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 |
|---|
volume_group_id required | string | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
Responses
| Name | Description | Example |
|---|
| created_dt | Created dt | 2024-08-01T07:07:23.315Z |
| snapshot_id | Snapshot id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
| snapshot_name | Snapshot name | vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932 |
1.23.3 - 1.1
scpcli baremetal-blockstorage volume-group snapshot list
--volume_group_id <value>
Description
Get a list of Volume Group snapshots.
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 |
|---|
volume_group_id required | string | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
Responses
| Name | Description | Example |
|---|
| created_dt | Created dt | 2024-08-01T07:07:23.315Z |
| snapshot_id | Snapshot id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
| snapshot_name | Snapshot name | vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932 |
1.23.4 - 1.0
scpcli baremetal-blockstorage volume-group snapshot list
--volume_group_id <value>
Description
Get a list of Volume Group snapshots.
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_group_id required | string | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
Responses
| Name | Description | Example |
|---|
| created_dt | Created dt | 2024-08-01T07:07:23.315Z |
| snapshot_id | Snapshot id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
| snapshot_name | Snapshot name | vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932 |
1.24 - List Volume Groups
1.24.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)
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 | |
1.24.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 | |
1.24.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 | |
1.24.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 | |
1.25 - List Volume Snapshots
1.25.1 - 1.3
scpcli baremetal-blockstorage volume snapshot list
--volume_id <value>
Description
Get a list of Volume snapshots.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
volume_id required | string | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
Responses
| Name | Description | Example |
|---|
| created_dt | Created dt | 2024-08-01T07:07:23.315Z |
| snapshot_id | Snapshot id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
| snapshot_name | Snapshot name | vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932 |
| snapshot_size_mb | Snapshot size(MB) | 0 |
1.25.2 - 1.2
scpcli baremetal-blockstorage volume snapshot list
--volume_id <value>
Description
Get a list of Volume snapshots.
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 |
|---|
volume_id required | string | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
Responses
| Name | Description | Example |
|---|
| created_dt | Created dt | 2024-08-01T07:07:23.315Z |
| snapshot_id | Snapshot id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
| snapshot_name | Snapshot name | vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932 |
| snapshot_size_mb | Snapshot size(MB) | 0 |
1.25.3 - 1.1
scpcli baremetal-blockstorage volume snapshot list
--volume_id <value>
Description
Get a list of Volume snapshots.
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 |
|---|
volume_id required | string | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
Responses
| Name | Description | Example |
|---|
| created_dt | Created dt | 2024-08-01T07:07:23.315Z |
| snapshot_id | Snapshot id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
| snapshot_name | Snapshot name | vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932 |
| snapshot_size_mb | Snapshot size(MB) | 0 |
1.25.4 - 1.0
scpcli baremetal-blockstorage volume snapshot list
--volume_id <value>
Description
Get a list of Volume snapshots.
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 | 92cd16fe8ebc4f73832513a172bf0000 |
Responses
| Name | Description | Example |
|---|
| created_dt | Created dt | 2024-08-01T07:07:23.315Z |
| snapshot_id | Snapshot id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
| snapshot_name | Snapshot name | vo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932 |
| snapshot_size_mb | Snapshot size(MB) | 0 |
1.26 - List Volumes
1.26.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)
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 | |
1.26.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 | |
1.26.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 | |
1.26.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 | |
1.27 - Remove Volume Group Member on Volume Group
1.27.1 - 1.3
scpcli baremetal-blockstorage volume-group member remove
--volume_group_id <value>
--volume_ids <value>
Description
Remove Volume Group Member on Volume Group.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
volume_group_id required | string | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
volume_ids required | array | List of volume(Block Storage) id | 13666d6c32d4456e8421f7768d0bf225 |
1.27.2 - 1.2
scpcli baremetal-blockstorage volume-group member remove
--volume_group_id <value>
--volume_ids <value>
Description
Remove Volume Group Member on Volume Group.
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 |
|---|
volume_group_id required | string | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
volume_ids required | array | List of volume(Block Storage) id | 13666d6c32d4456e8421f7768d0bf225 |
1.27.3 - 1.1
scpcli baremetal-blockstorage volume-group member remove
--volume_group_id <value>
--volume_ids <value>
Description
Remove Volume Group Member on Volume Group.
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 |
|---|
volume_group_id required | string | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
volume_ids required | array | List of volume(Block Storage) id | 13666d6c32d4456e8421f7768d0bf225 |
1.27.4 - 1.0
scpcli baremetal-blockstorage volume-group member remove
--volume_group_id <value>
--volume_ids <value>
Description
Remove Volume Group Member on Volume Group.
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_group_id required | string | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
volume_ids required | array | List of volume(Block Storage) id | 13666d6c32d4456e8421f7768d0bf225 |
1.28 - Restore Volume Group Snapshot
1.28.1 - 1.3
scpcli baremetal-blockstorage volume-group snapshot restore
--snapshot_id <value>
--volume_group_id <value>
Description
Restore Volume Group snapshot.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
snapshot_id required | string | Snapshot id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
volume_group_id required | string | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
1.28.2 - 1.2
scpcli baremetal-blockstorage volume-group snapshot restore
--snapshot_id <value>
--volume_group_id <value>
Description
Restore Volume Group snapshot.
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 |
|---|
snapshot_id required | string | Snapshot id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
volume_group_id required | string | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
1.28.3 - 1.1
scpcli baremetal-blockstorage volume-group snapshot restore
--snapshot_id <value>
--volume_group_id <value>
Description
Restore Volume Group snapshot.
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 |
|---|
snapshot_id required | string | Snapshot id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
volume_group_id required | string | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
1.28.4 - 1.0
scpcli baremetal-blockstorage volume-group snapshot restore
--snapshot_id <value>
--volume_group_id <value>
Description
Restore Volume Group snapshot.
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 |
|---|
snapshot_id required | string | Snapshot id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
volume_group_id required | string | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
1.29 - Restore Volume Snapshot
1.29.1 - 1.3
scpcli baremetal-blockstorage volume snapshot restore
--snapshot_id <value>
--volume_id <value>
Description
Restore Volume from snapshot.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
snapshot_id required | string | Snapshot id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
volume_id required | string | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
1.29.2 - 1.2
scpcli baremetal-blockstorage volume snapshot restore
--snapshot_id <value>
--volume_id <value>
Description
Restore Volume from snapshot.
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 |
|---|
snapshot_id required | string | Snapshot id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
volume_id required | string | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
1.29.3 - 1.1
scpcli baremetal-blockstorage volume snapshot restore
--snapshot_id <value>
--volume_id <value>
Description
Restore Volume from snapshot.
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 |
|---|
snapshot_id required | string | Snapshot id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
volume_id required | string | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
1.29.4 - 1.0
scpcli baremetal-blockstorage volume snapshot restore
--snapshot_id <value>
--volume_id <value>
Description
Restore Volume from snapshot.
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 |
|---|
snapshot_id required | string | Snapshot id | 05600123-6e78-11f0-a3f0-d039eab8d501 |
volume_id required | string | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
1.30 - Set Volume Group Replication Cycle
1.30.1 - 1.3
scpcli baremetal-blockstorage volume-group replication-cycle set
--volume_group_id <value>
--cycle <value>
Description
Set Volume Group Replication Cycle.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
volume_group_id required | string | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
cycle required | string | Replication cycle | - |
1.30.2 - 1.2
scpcli baremetal-blockstorage volume-group replication-cycle set
--volume_group_id <value>
--cycle <value>
Description
Set Volume Group Replication Cycle.
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 |
|---|
volume_group_id required | string | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
cycle required | string | Replication cycle | - |
1.30.3 - 1.1
scpcli baremetal-blockstorage volume-group replication-cycle set
--volume_group_id <value>
--cycle <value>
Description
Set Volume Group Replication Cycle.
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 |
|---|
volume_group_id required | string | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
cycle required | string | Replication cycle | - |
1.30.4 - 1.0
scpcli baremetal-blockstorage volume-group replication-cycle set
--volume_group_id <value>
--cycle <value>
Description
Set Volume Group Replication Cycle.
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_group_id required | string | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
cycle required | string | Replication cycle | - |
1.31 - Set Volume Group Replication Policy
1.31.1 - 1.3
scpcli baremetal-blockstorage volume-group replication-policy set
--volume_group_id <value>
--policy <value>
Description
Set Volume Group Replication Policy.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
volume_group_id required | string | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
policy required | string | Policy | - |
1.31.2 - 1.2
scpcli baremetal-blockstorage volume-group replication-policy set
--volume_group_id <value>
--policy <value>
Description
Set Volume Group Replication Policy.
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 |
|---|
volume_group_id required | string | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
policy required | string | Policy | - |
1.31.3 - 1.1
scpcli baremetal-blockstorage volume-group replication-policy set
--volume_group_id <value>
--policy <value>
Description
Set Volume Group Replication Policy.
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 |
|---|
volume_group_id required | string | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
policy required | string | Policy | - |
1.31.4 - 1.0
scpcli baremetal-blockstorage volume-group replication-policy set
--volume_group_id <value>
--policy <value>
Description
Set Volume Group Replication Policy.
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_group_id required | string | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
policy required | string | Policy | - |
1.32 - Set Volume Group Snapshot Schedule
1.32.1 - 1.3
scpcli baremetal-blockstorage volume-group snapshot-schedule set
--volume_group_id <value>
--hour <value>
[--day_of_week <value>]
Description
Set Volume Group Snapshot Schedule.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
volume_group_id required | string | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
hour required | integer | Hour | 18 |
day_of_week optional | string | Day of week(If this field is excluded, the schedule frequency is set to DAILY.) | - |
1.32.2 - 1.2
scpcli baremetal-blockstorage volume-group snapshot-schedule set
--volume_group_id <value>
--hour <value>
[--day_of_week <value>]
Description
Set Volume Group Snapshot Schedule.
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 |
|---|
volume_group_id required | string | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
hour required | integer | Hour | 18 |
day_of_week optional | string | Day of week(If this field is excluded, the schedule frequency is set to DAILY.) | - |
1.32.3 - 1.1
scpcli baremetal-blockstorage volume-group snapshot-schedule set
--volume_group_id <value>
--hour <value>
[--day_of_week <value>]
Description
Set Volume Group Snapshot Schedule.
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 |
|---|
volume_group_id required | string | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
hour required | integer | Hour | 18 |
day_of_week optional | string | Day of week(If this field is excluded, the schedule frequency is set to DAILY.) | - |
1.32.4 - 1.0
scpcli baremetal-blockstorage volume-group snapshot-schedule set
--volume_group_id <value>
--hour <value>
[--day_of_week <value>]
Description
Set Volume Group Snapshot Schedule.
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_group_id required | string | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
hour required | integer | Hour | 18 |
day_of_week optional | string | Day of week(If this field is excluded, the schedule frequency is set to DAILY.) | - |
1.33 - Set Volume QoS
1.33.1 - 1.3
scpcli baremetal-blockstorage volume qos set
--volume_id <value>
[--iops <value>]
[--throughput <value>]
Description
Change volume QoS
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
volume_id required | string | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
iops optional | integer | IOPS. If omitted, the existing value will be retained. | 5000 |
throughput optional | integer | Throughput. If omitted, the existing value will be retained. | 250 |
1.33.2 - 1.2
scpcli baremetal-blockstorage volume qos set
--volume_id <value>
[--iops <value>]
[--throughput <value>]
Description
Change volume QoS
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 |
|---|
volume_id required | string | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
iops optional | integer | IOPS. If omitted, the existing value will be retained. | 5000 |
throughput optional | integer | Throughput. If omitted, the existing value will be retained. | 250 |
1.34 - Set Volume Replication Cycle
1.34.1 - 1.3
scpcli baremetal-blockstorage volume replication-cycle set
--volume_id <value>
--cycle <value>
Description
Set Volume Replication Cycle.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
volume_id required | string | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
cycle required | string | Replication cycle | 5MIN |
1.34.2 - 1.2
scpcli baremetal-blockstorage volume replication-cycle set
--volume_id <value>
--cycle <value>
Description
Set Volume Replication Cycle.
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 |
|---|
volume_id required | string | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
cycle required | string | Replication cycle | 5MIN |
1.34.3 - 1.1
scpcli baremetal-blockstorage volume replication-cycle set
--volume_id <value>
--cycle <value>
Description
Set Volume Replication Cycle.
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 |
|---|
volume_id required | string | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
cycle required | string | Replication cycle | 5MIN |
1.34.4 - 1.0
scpcli baremetal-blockstorage volume replication-cycle set
--volume_id <value>
--cycle <value>
Description
Set Volume Replication Cycle.
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 | 92cd16fe8ebc4f73832513a172bf0000 |
cycle required | string | Replication cycle | 5MIN |
1.35 - Set Volume Replication Policy
1.35.1 - 1.3
scpcli baremetal-blockstorage volume replication-policy set
--volume_id <value>
--policy <value>
Description
Set Volume Replication Policy.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
volume_id required | string | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
policy required | string | Policy | - |
1.35.2 - 1.2
scpcli baremetal-blockstorage volume replication-policy set
--volume_id <value>
--policy <value>
Description
Set Volume Replication Policy.
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 |
|---|
volume_id required | string | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
policy required | string | Policy | - |
1.35.3 - 1.1
scpcli baremetal-blockstorage volume replication-policy set
--volume_id <value>
--policy <value>
Description
Set Volume Replication Policy.
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 |
|---|
volume_id required | string | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
policy required | string | Policy | - |
1.35.4 - 1.0
scpcli baremetal-blockstorage volume replication-policy set
--volume_id <value>
--policy <value>
Description
Set Volume Replication Policy.
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 | 92cd16fe8ebc4f73832513a172bf0000 |
policy required | string | Policy | - |
1.36 - Set Volume Snapshot Rate
1.36.1 - 1.3
scpcli baremetal-blockstorage volume snapshot-rate set
--volume_id <value>
--snapshot_rate <value>
Description
Set Volume snapshot rate.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
volume_id required | string | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
snapshot_rate required | integer | Snapshot rate | 100 |
1.36.2 - 1.2
scpcli baremetal-blockstorage volume snapshot-rate set
--volume_id <value>
--snapshot_rate <value>
Description
Set Volume snapshot rate.
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 |
|---|
volume_id required | string | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
snapshot_rate required | integer | Snapshot rate | 100 |
1.36.3 - 1.1
scpcli baremetal-blockstorage volume snapshot-rate set
--volume_id <value>
--snapshot_rate <value>
Description
Set Volume snapshot rate.
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 |
|---|
volume_id required | string | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
snapshot_rate required | integer | Snapshot rate | 100 |
1.36.4 - 1.0
scpcli baremetal-blockstorage volume snapshot-rate set
--volume_id <value>
--snapshot_rate <value>
Description
Set Volume snapshot rate.
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 | 92cd16fe8ebc4f73832513a172bf0000 |
snapshot_rate required | integer | Snapshot rate | 100 |
1.37 - Set Volume Snapshot Schedule
1.37.1 - 1.3
scpcli baremetal-blockstorage volume snapshot-schedule set
--volume_id <value>
--hour <value>
[--day_of_week <value>]
Description
Set Volume snapshot schedule.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
volume_id required | string | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
hour required | integer | Hour | 18 |
day_of_week optional | string | Day of week(If this field is excluded, the schedule frequency is set to DAILY.) | - |
1.37.2 - 1.2
scpcli baremetal-blockstorage volume snapshot-schedule set
--volume_id <value>
--hour <value>
[--day_of_week <value>]
Description
Set Volume snapshot schedule.
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 |
|---|
volume_id required | string | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
hour required | integer | Hour | 18 |
day_of_week optional | string | Day of week(If this field is excluded, the schedule frequency is set to DAILY.) | - |
1.37.3 - 1.1
scpcli baremetal-blockstorage volume snapshot-schedule set
--volume_id <value>
--hour <value>
[--day_of_week <value>]
Description
Set Volume snapshot schedule.
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 |
|---|
volume_id required | string | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
hour required | integer | Hour | 18 |
day_of_week optional | string | Day of week(If this field is excluded, the schedule frequency is set to DAILY.) | - |
1.37.4 - 1.0
scpcli baremetal-blockstorage volume snapshot-schedule set
--volume_id <value>
--hour <value>
[--day_of_week <value>]
Description
Set Volume snapshot schedule.
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 | 92cd16fe8ebc4f73832513a172bf0000 |
hour required | integer | Hour | 18 |
day_of_week optional | string | Day of week(If this field is excluded, the schedule frequency is set to DAILY.) | - |
1.38 - Show Volume
1.38.1 - 1.3
scpcli baremetal-blockstorage volume show
--volume_id <value>
Description
Show Volume.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
volume_id required | string | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
Responses
| Name | Description | Example |
|---|
| result | Volume detail | |
1.38.2 - 1.2
scpcli baremetal-blockstorage volume show
--volume_id <value>
Description
Show Volume.
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 |
|---|
volume_id required | string | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
Responses
| Name | Description | Example |
|---|
| result | Volume detail | |
1.38.3 - 1.1
scpcli baremetal-blockstorage volume show
--volume_id <value>
Description
Show Volume.
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 |
|---|
volume_id required | string | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
Responses
| Name | Description | Example |
|---|
| result | Volume detail | |
1.38.4 - 1.0
scpcli baremetal-blockstorage volume show
--volume_id <value>
Description
Show Volume.
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 | 92cd16fe8ebc4f73832513a172bf0000 |
Responses
| Name | Description | Example |
|---|
| result | Volume detail | |
1.39 - Show Volume Group
1.39.1 - 1.3
scpcli baremetal-blockstorage volume-group show
--volume_group_id <value>
Description
Show Volume Group
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
volume_group_id required | string | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
Responses
| Name | Description | Example |
|---|
| result | Volume group detail | |
1.39.2 - 1.2
scpcli baremetal-blockstorage volume-group show
--volume_group_id <value>
Description
Show Volume Group
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 |
|---|
volume_group_id required | string | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
Responses
| Name | Description | Example |
|---|
| result | Volume group detail | |
1.39.3 - 1.1
scpcli baremetal-blockstorage volume-group show
--volume_group_id <value>
Description
Show Volume Group
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 |
|---|
volume_group_id required | string | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
Responses
| Name | Description | Example |
|---|
| result | Volume group detail | |
1.39.4 - 1.0
scpcli baremetal-blockstorage volume-group show
--volume_group_id <value>
Description
Show Volume Group
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_group_id required | string | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
Responses
| Name | Description | Example |
|---|
| result | Volume group detail | |
1.40 - Show Volume Group Replication
1.40.1 - 1.3
scpcli baremetal-blockstorage volume-group replication show
--volume_group_id <value>
Description
Show Volume Group Replication
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
volume_group_id required | string | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
Responses
| Name | Description | Example |
|---|
| result | Volume group replication detail | |
1.40.2 - 1.2
scpcli baremetal-blockstorage volume-group replication show
--volume_group_id <value>
Description
Show Volume Group Replication
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 |
|---|
volume_group_id required | string | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
Responses
| Name | Description | Example |
|---|
| result | Volume group replication detail | |
1.40.3 - 1.1
scpcli baremetal-blockstorage volume-group replication show
--volume_group_id <value>
Description
Show Volume Group Replication
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 |
|---|
volume_group_id required | string | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
Responses
| Name | Description | Example |
|---|
| result | Volume group replication detail | |
1.40.4 - 1.0
scpcli baremetal-blockstorage volume-group replication show
--volume_group_id <value>
Description
Show Volume Group Replication
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_group_id required | string | Volume group id | c9ecae8b973b425c81c3817893cd8063 |
Responses
| Name | Description | Example |
|---|
| result | Volume group replication detail | |
1.41 - Show Volume Replication
1.41.1 - 1.3
scpcli baremetal-blockstorage volume replication show
--volume_id <value>
Description
Show Volume Replication.
State
ACTIVE (CURRENT)
Parameters
| Name | Type | Description | Example |
|---|
volume_id required | string | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
Responses
| Name | Description | Example |
|---|
| result | Volume replication detail | |
1.41.2 - 1.2
scpcli baremetal-blockstorage volume replication show
--volume_id <value>
Description
Show Volume Replication.
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 |
|---|
volume_id required | string | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
Responses
| Name | Description | Example |
|---|
| result | Volume replication detail | |
1.41.3 - 1.1
scpcli baremetal-blockstorage volume replication show
--volume_id <value>
Description
Show Volume Replication.
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 |
|---|
volume_id required | string | Volume id | 92cd16fe8ebc4f73832513a172bf0000 |
Responses
| Name | Description | Example |
|---|
| result | Volume replication detail | |
1.41.4 - 1.0
scpcli baremetal-blockstorage volume replication show
--volume_id <value>
Description
Show Volume Replication.
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 | 92cd16fe8ebc4f73832513a172bf0000 |
Responses
| Name | Description | Example |
|---|
| result | Volume replication detail | |