This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Storage

1: Archive Storage

1.1: CLIs

1.1.1: CancelArchiving

1.1.1.1: 1.1
1.1.1.2: 1.0

1.1.2: CancelRecovery

1.1.2.1: 1.1
1.1.2.2: 1.0

1.1.3: CreateArchivingPolicy

1.1.3.1: 1.1
1.1.3.2: 1.0

1.1.4: CreateBucket

1.1.4.1: 1.1
1.1.4.2: 1.0

1.1.5: DeleteBucket

1.1.5.1: 1.1
1.1.5.2: 1.0

1.1.6: DeleteBucketObjects

1.1.6.1: 1.1
1.1.6.2: 1.0

1.1.7: DeleteBucketObjectVersions

1.1.7.1: 1.1

1.1.8: ListArchivingHistories

1.1.8.1: 1.1
1.1.8.2: 1.0

1.1.9: ListArchivingPolicies

1.1.9.1: 1.1
1.1.9.2: 1.0

1.1.10: ListBucketObjects

1.1.10.1: 1.1
1.1.10.2: 1.0

1.1.11: ListBucketObjectVersions

1.1.11.1: 1.1

1.1.12: ListBuckets

1.1.12.1: 1.1
1.1.12.2: 1.0

1.1.13: ListRecoveryHistories

1.1.13.1: 1.1
1.1.13.2: 1.0

1.1.14: RecoverObjects

1.1.14.1: 1.1
1.1.14.2: 1.0

1.1.15: RecoverObjectVersions

1.1.15.1: 1.1

1.1.16: SetArchivingPolicy

1.1.16.1: 1.1
1.1.16.2: 1.0

1.1.17: SetArchivingPolicyState

1.1.17.1: 1.1

1.1.18: SetBucketEncryption

1.1.18.1: 1.1
1.1.18.2: 1.0

1.1.19: SetBucketVersioning

1.1.19.1: 1.1

1.1.20: ShowArchivingHistory

1.1.20.1: 1.1
1.1.20.2: 1.0

1.1.21: ShowArchivingPolicy

1.1.21.1: 1.1
1.1.21.2: 1.0

1.1.22: ShowBucket

1.1.22.1: 1.1
1.1.22.2: 1.0

1.1.23: ShowBucketEncryption

1.1.23.1: 1.1
1.1.23.2: 1.0

1.1.24: ShowBucketVersioning

1.1.24.1: 1.1

1.1.25: ShowRecoveryHistory

1.1.25.1: 1.1
1.1.25.2: 1.0

2: Backup

2.1: CLIs

2.1.1: Check Backup Master Connection State

2.1.1.1: 1.1
2.1.1.2: 1.0

2.1.2: Check Backup Name Duplicate

2.1.2.1: 1.1
2.1.2.2: 1.0

2.1.3: Check Backup Restore Server Name Duplicate

2.1.3.1: 1.1
2.1.3.2: 1.0

2.1.4: Check Filesystem Path Duplication

2.1.4.1: 1.1
2.1.4.2: 1.0

2.1.5: Create Backup

2.1.5.1: 1.1
2.1.5.2: 1.0

2.1.6: Create Backup Agent

2.1.6.1: 1.1
2.1.6.2: 1.0

2.1.7: Delete Backup

2.1.7.1: 1.1
2.1.7.2: 1.0

2.1.8: Delete Backup Agent

2.1.8.1: 1.1
2.1.8.2: 1.0

2.1.9: Delete Backup Restore Target

2.1.9.1: 1.1
2.1.9.2: 1.0

2.1.10: List Agent Backup Restore Target Servers

2.1.10.1: 1.1
2.1.10.2: 1.0

2.1.11: List Backup Agents

2.1.11.1: 1.1
2.1.11.2: 1.0

2.1.12: List Backup Histories

2.1.12.1: 1.1
2.1.12.2: 1.0

2.1.13: List Backup Region Relationship

2.1.13.1: 1.1
2.1.13.2: 1.0

2.1.14: List Backup Restore Histories

2.1.14.1: 1.1
2.1.14.2: 1.0

2.1.15: List Backup Restore Subnets

2.1.15.1: 1.1
2.1.15.2: 1.0

2.1.16: List Backup Restore Targets

2.1.16.1: 1.1
2.1.16.2: 1.0

2.1.17: List Backup Schedules

2.1.17.1: 1.1
2.1.17.2: 1.0

2.1.18: List Backup Targets

2.1.18.1: 1.1
2.1.18.2: 1.0

2.1.19: List Backups

2.1.19.1: 1.1
2.1.19.2: 1.0

2.1.20: List Targets of Backup Agent

2.1.20.1: 1.1
2.1.20.2: 1.0

2.1.21: Manual Backup

2.1.21.1: 1.1
2.1.21.2: 1.0

2.1.22: Restore Agent Backup

2.1.22.1: 1.1
2.1.22.2: 1.0

2.1.23: Restore Backup

2.1.23.1: 1.1
2.1.23.2: 1.0

2.1.24: Set Backup Schedule

2.1.24.1: 1.1
2.1.24.2: 1.0

2.1.25: Set Filesystem Path

2.1.25.1: 1.1
2.1.25.2: 1.0

2.1.26: Show Backup

2.1.26.1: 1.1
2.1.26.2: 1.0

2.1.27: Show Backup Agent

2.1.27.1: 1.1
2.1.27.2: 1.0

2.1.28: Show Backup Agent Install File Path

2.1.28.1: 1.1
2.1.28.2: 1.0

2.1.29: Update Replication Use

2.1.29.1: 1.1
2.1.29.2: 1.0

2.1.30: Update Retention Period

2.1.30.1: 1.1
2.1.30.2: 1.0

3: Block Storage(BM)

3.1: CLIs

3.1.1: Add Volume Group Member on Volume Group

3.1.1.1: 1.2
3.1.1.2: 1.1
3.1.1.3: 1.0

3.1.2: Attach Volume

3.1.2.1: 1.2
3.1.2.2: 1.1
3.1.2.3: 1.0

3.1.3: Create Volume

3.1.3.1: 1.2
3.1.3.2: 1.1
3.1.3.3: 1.0

3.1.4: Create Volume Group

3.1.4.1: 1.2
3.1.4.2: 1.1
3.1.4.3: 1.0

3.1.5: Create Volume Group Recovery

3.1.5.1: 1.2
3.1.5.2: 1.1

3.1.6: Create Volume Group Replication

3.1.6.1: 1.2
3.1.6.2: 1.1
3.1.6.3: 1.0

3.1.7: Create Volume Group Snapshot

3.1.7.1: 1.2
3.1.7.2: 1.1
3.1.7.3: 1.0

3.1.8: Create Volume Group Snapshot Schedule

3.1.8.1: 1.2
3.1.8.2: 1.1
3.1.8.3: 1.0

3.1.9: Create Volume Recovery

3.1.9.1: 1.2
3.1.9.2: 1.1

3.1.10: Create Volume Replication

3.1.10.1: 1.2
3.1.10.2: 1.1
3.1.10.3: 1.0

3.1.11: Create Volume Snapshot

3.1.11.1: 1.2
3.1.11.2: 1.1
3.1.11.3: 1.0

3.1.12: Create Volume Snapshot Rate

3.1.12.1: 1.2
3.1.12.2: 1.1
3.1.12.3: 1.0

3.1.13: Create Volume Snapshot Schedule

3.1.13.1: 1.2
3.1.13.2: 1.1
3.1.13.3: 1.0

3.1.14: Delete Volume

3.1.14.1: 1.2
3.1.14.2: 1.1
3.1.14.3: 1.0

3.1.15: Delete Volume Group Replication

3.1.15.1: 1.2
3.1.15.2: 1.1
3.1.15.3: 1.0

3.1.16: Delete Volume Group Snapshot

3.1.16.1: 1.2
3.1.16.2: 1.1
3.1.16.3: 1.0

3.1.17: Delete Volume Group Snapshot Schedule

3.1.17.1: 1.2
3.1.17.2: 1.1
3.1.17.3: 1.0

3.1.18: Delete Volume Replication

3.1.18.1: 1.2
3.1.18.2: 1.1
3.1.18.3: 1.0

3.1.19: Delete Volume Snapshot

3.1.19.1: 1.2
3.1.19.2: 1.1
3.1.19.3: 1.0

3.1.20: Delete Volume Snapshot Rate

3.1.20.1: 1.2
3.1.20.2: 1.1
3.1.20.3: 1.0

3.1.21: Delete Volume Snapshot Schedule

3.1.21.1: 1.2
3.1.21.2: 1.1
3.1.21.3: 1.0

3.1.22: Detach Volume

3.1.22.1: 1.2
3.1.22.2: 1.1
3.1.22.3: 1.0

3.1.23: List Volume Group Snapshots

3.1.23.1: 1.2
3.1.23.2: 1.1
3.1.23.3: 1.0

3.1.24: List Volume Groups

3.1.24.1: 1.2
3.1.24.2: 1.1
3.1.24.3: 1.0

3.1.25: List Volume Snapshots

3.1.25.1: 1.2
3.1.25.2: 1.1
3.1.25.3: 1.0

3.1.26: List Volumes

3.1.26.1: 1.2
3.1.26.2: 1.1
3.1.26.3: 1.0

3.1.27: Remove Volume Group Member on Volume Group

3.1.27.1: 1.2
3.1.27.2: 1.1
3.1.27.3: 1.0

3.1.28: Restore Volume Group Snapshot

3.1.28.1: 1.2
3.1.28.2: 1.1
3.1.28.3: 1.0

3.1.29: Restore Volume Snapshot

3.1.29.1: 1.2
3.1.29.2: 1.1
3.1.29.3: 1.0

3.1.30: Set Volume Group Replication Cycle

3.1.30.1: 1.2
3.1.30.2: 1.1
3.1.30.3: 1.0

3.1.31: Set Volume Group Replication Policy

3.1.31.1: 1.2
3.1.31.2: 1.1
3.1.31.3: 1.0

3.1.32: Set Volume Group Snapshot Schedule

3.1.32.1: 1.2
3.1.32.2: 1.1
3.1.32.3: 1.0

3.1.33: Set Volume QoS

3.1.33.1: 1.2

3.1.34: Set Volume Replication Cycle

3.1.34.1: 1.2
3.1.34.2: 1.1
3.1.34.3: 1.0

3.1.35: Set Volume Replication Policy

3.1.35.1: 1.2
3.1.35.2: 1.1
3.1.35.3: 1.0

3.1.36: Set Volume Snapshot Rate

3.1.36.1: 1.2
3.1.36.2: 1.1
3.1.36.3: 1.0

3.1.37: Set Volume Snapshot Schedule

3.1.37.1: 1.2
3.1.37.2: 1.1
3.1.37.3: 1.0

3.1.38: Show Volume

3.1.38.1: 1.2
3.1.38.2: 1.1
3.1.38.3: 1.0

3.1.39: Show Volume Group

3.1.39.1: 1.2
3.1.39.2: 1.1
3.1.39.3: 1.0

3.1.40: Show Volume Group Replication

3.1.40.1: 1.2
3.1.40.2: 1.1
3.1.40.3: 1.0

3.1.41: Show Volume Replication

3.1.41.1: 1.2
3.1.41.2: 1.1
3.1.41.3: 1.0

4: File Storage

4.1: CLIs

4.1.1: CreateSnapshot

4.1.1.1: 1.1
4.1.1.2: 1.0

4.1.2: CreateSnapshotSchedule

4.1.2.1: 1.1
4.1.2.2: 1.0

4.1.3: CreateVolume

4.1.3.1: 1.1
4.1.3.2: 1.0

4.1.4: CreateVolumeReplication

4.1.4.1: 1.1
4.1.4.2: 1.0

4.1.5: DeleteSnapshot

4.1.5.1: 1.1
4.1.5.2: 1.0

4.1.6: DeleteSnapshotSchedule

4.1.6.1: 1.1
4.1.6.2: 1.0

4.1.7: DeleteVolume

4.1.7.1: 1.1
4.1.7.2: 1.0

4.1.8: DeleteVolumeReplication

4.1.8.1: 1.1
4.1.8.2: 1.0

4.1.9: ListAccessRules

4.1.9.1: 1.1
4.1.9.2: 1.0

4.1.10: ListSnapshots

4.1.10.1: 1.1
4.1.10.2: 1.0

4.1.11: ListSnapshotSchedule

4.1.11.1: 1.1
4.1.11.2: 1.0

4.1.12: ListVolumeReplicationRegion

4.1.12.1: 1.1
4.1.12.2: 1.0

4.1.13: ListVolumeReplications

4.1.13.1: 1.1
4.1.13.2: 1.0

4.1.14: ListVolumes

4.1.14.1: 1.1
4.1.14.2: 1.0

4.1.15: RestoreSnapshot

4.1.15.1: 1.1
4.1.15.2: 1.0

4.1.16: SetAccessRule

4.1.16.1: 1.1
4.1.16.2: 1.0

4.1.17: SetSnapshotSchedule

4.1.17.1: 1.1
4.1.17.2: 1.0

4.1.18: SetVolume

4.1.18.1: 1.1
4.1.18.2: 1.0

4.1.19: SetVolumeReplication

4.1.19.1: 1.1
4.1.19.2: 1.0

4.1.20: ShowVolume

4.1.20.1: 1.1
4.1.20.2: 1.0

4.1.21: ShowVolumeReplication

4.1.21.1: 1.1
4.1.21.2: 1.0

5: Parallel File Storage

5.1: CLIs

5.1.1: CreateSnapshot

5.1.1.1: 1.0

5.1.2: CreateVolume

5.1.2.1: 1.0

5.1.3: DeleteSnapshot

5.1.3.1: 1.0

5.1.4: DeleteVolume

5.1.4.1: 1.0

5.1.5: ListAccessRule

5.1.5.1: 1.0

5.1.6: ListSnapshots

5.1.6.1: 1.0

5.1.7: ListVolumes

5.1.7.1: 1.0

5.1.8: SetAccessRule

5.1.8.1: 1.0

5.1.9: SetVolumeCapacity

5.1.9.1: 1.0

5.1.10: ShowVolume

5.1.10.1: 1.0

1 - Archive Storage

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 Archive Storage service and how to call CLI.

Version

Version	Status	Supported Until
1.0	DEPRECATED	20251231
1.1	CURRENT	-

1.1 - CLIs

1.1.1 - CancelArchiving

1.1.1.1 - 1.1

scpcli archivestorage archiving history cancel
--bucket_id <value>
--id <value>

Description

Cancel a specific archiving

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
bucket_id required	string	Bucket ID	`3d036efe-f576-48b0-8375-6d3704a95b63`
id required	string	Archiving History ID	`EXE-8f35b491-a060-453b-b825-e78440ca46de`

1.1.1.2 - 1.0

scpcli archivestorage archiving history cancel
--bucket_id <value>
--id <value>

Description

Cancel a specific archiving

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
bucket_id required	string	Bucket ID	`3d036efe-f576-48b0-8375-6d3704a95b63`
id required	string	Archiving History ID	`EXE-8f35b491-a060-453b-b825-e78440ca46de`

1.1.2 - CancelRecovery

1.1.2.1 - 1.1

scpcli archivestorage recovery history cancel
--bucket_id <value>
--id <value>

Description

Cancel a specific recovery

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
bucket_id required	string	Bucket ID	`7d8d8c2b-d02a-421e-a6e3-5b981bfb507f`
id required	string	Recovery History ID	`EXE-9df439a5-9e6d-46a4-806e-1e9991520763`

1.1.2.2 - 1.0

scpcli archivestorage recovery history cancel
--bucket_id <value>
--id <value>

Description

Cancel a specific recovery

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
bucket_id required	string	Bucket ID	`7d8d8c2b-d02a-421e-a6e3-5b981bfb507f`
id required	string	Recovery History ID	`EXE-9df439a5-9e6d-46a4-806e-1e9991520763`

1.1.3 - CreateArchivingPolicy

1.1.3.1 - 1.1

scpcli archivestorage archiving policy create
--bucket_id <value>
--object_path <value>
--object_lifecycle <value>
--archiving_source_bucket_name <value>

Description

Create an archivingPolicy

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
bucket_id required	string	Bucket ID	`138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`
object_path required	string	Object Path	`/`
object_lifecycle required	string	Object LifeCycle	`1`
archiving_source_bucket_name required	string	Archiving Source Bucket Name	`obs-bucket-name`

Responses

Name	Description	Example
id	Archiving Policy ID	SCH-XXXXXXX
bucket_id	Bucket ID	138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
archiving_source	Archiving Source
object_lifecycle	Object LifeCycle	1
state	Archiving Policy State	ACTIVE

1.1.3.2 - 1.0

scpcli archivestorage archiving policy create
--bucket_id <value>
--object_path <value>
--object_lifecycle <value>
--archiving_source_bucket_name <value>

Description

Create an archivingPolicy

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
bucket_id required	string	Bucket ID	`138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`
object_path required	string	Object Path	`/`
object_lifecycle required	string	Object LifeCycle	`1`
archiving_source_bucket_name required	string	Archiving Source Bucket Name	`obs-bucket-name`

Responses

Name	Description	Example
id	Archiving Policy ID	SCH-XXXXXXX
bucket_id	Bucket ID	138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
archiving_source	Archiving Source
object_lifecycle	Object LifeCycle	1
state	Archiving Policy State	ACTIVE

1.1.4 - CreateBucket

1.1.4.1 - 1.1

scpcli archivestorage bucket create
--name <value>
[--tags <value>]

Description

Create a bucket

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
name required	string	Bucket name	`astest`
tags optional	array	Tag List	`'{"key": "key", "value": "value"}'`

Responses

Name	Description	Example
id	Bucket ID	138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2

1.1.4.2 - 1.0

scpcli archivestorage bucket create
--name <value>
[--tags <value>]

Description

Create a bucket

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
name required	string	Bucket name	`astest`
tags optional	array	Tag List	`'{"key": "key", "value": "value"}'`

Responses

Name	Description	Example
id	Bucket ID	138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2

1.1.5 - DeleteBucket

1.1.5.1 - 1.1

scpcli archivestorage bucket delete
--bucket_id <value>

Description

Delete a specific bucket

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
bucket_id required	string	Bucket ID	`138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`

1.1.5.2 - 1.0

scpcli archivestorage bucket delete
--bucket_id <value>

Description

Delete a specific bucket

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
bucket_id required	string	Bucket ID	`138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`

1.1.6 - DeleteBucketObjects

1.1.6.1 - 1.1

scpcli archivestorage bucket object delete
--bucket_id <value>
--paths <value>

Description

Delete Bucket Objects

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
bucket_id required	string	Bucket ID	`138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`
paths required	array	Object Path List	`test/`

1.1.6.2 - 1.0

scpcli archivestorage bucket object delete
--bucket_id <value>
--paths <value>

Description

Delete Bucket Objects

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
bucket_id required	string	Bucket ID	`138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`
paths required	array	Object Path List	`test/`

1.1.7 - DeleteBucketObjectVersions

1.1.7.1 - 1.1

scpcli archivestorage bucket object version delete
--bucket_id <value>
--versions <value>
--path <value>

Description

Delete Bucket Object Versions

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
bucket_id required	string	Bucket ID	`138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`
versions required	array	Object Version List	`Oc9nEYWV.6VjzsIMXFZWM1zL8HcYvKl`
path required	string	Object Path	`hello/my_file.txt`

1.1.8 - ListArchivingHistories

1.1.8.1 - 1.1

scpcli archivestorage archiving history list
--start_at_to <value>
--start_at_from <value>
--bucket_id <value>
[--state <value>]
[--limit <value>]
[--offset <value>]

Description

List archiving histories

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
start_at_to required	string	Start at to	`2025-04-30T23:59:59+09:00`
start_at_from required	string	Start at from	`2025-04-01T00:00:00+09:00`
bucket_id required	string	Bucket ID	`3d036efe-f576-48b0-8375-6d3704a95b63`
state optional	string	State	`SUCCESS`
limit optional	integer	Limit	`20`
offset optional	integer	Offset	`0`

Responses

Name	Description	Example
id	Archiving History ID	EXE-8f35b491-a060-453b-b825-e78440ca46de
archiving_id	Archiving ID	SCH-02d48456-0f35-47e2-8056-b00e09366cac
state	State	SUCCESS
archiving_policy_id	Archiving Policy ID	SCH-02d48456-0f35-47e2-8056-b00e09366cac
start_at	Start at	2025-04-01T00:00:00+09:00
end_at	End at	2025-04-30T23:59:59+09:00

1.1.8.2 - 1.0

scpcli archivestorage archiving history list
--start_at_to <value>
--start_at_from <value>
--bucket_id <value>
[--state <value>]
[--limit <value>]
[--offset <value>]

Description

List archiving histories

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
start_at_to required	string	Start at to	`2025-04-30T23:59:59+09:00`
start_at_from required	string	Start at from	`2025-04-01T00:00:00+09:00`
bucket_id required	string	Bucket ID	`3d036efe-f576-48b0-8375-6d3704a95b63`
state optional	string	State	`SUCCESS`
limit optional	integer	Limit	`20`
offset optional	integer	Offset	`0`

Responses

Name	Description	Example
id	Archiving History ID	EXE-8f35b491-a060-453b-b825-e78440ca46de
archiving_id	Archiving ID	SCH-02d48456-0f35-47e2-8056-b00e09366cac
state	State	SUCCESS
archiving_policy_id	Archiving Policy ID	SCH-02d48456-0f35-47e2-8056-b00e09366cac
start_at	Start at	2025-04-01T00:00:00+09:00
end_at	End at	2025-04-30T23:59:59+09:00

1.1.9 - ListArchivingPolicies

1.1.9.1 - 1.1

scpcli archivestorage archiving policy list
--bucket_id <value>

Description

List archiving policies

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
bucket_id required	string	Bucket ID	`138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`

Responses

Name	Description	Example
id	Archiving Policy ID	SCH-XXXXXXX
object_lifecycle	Object LifeCycle	1
object_path	Object Path	/
state	Archiving Policy State	ACTIVE

1.1.9.2 - 1.0

scpcli archivestorage archiving policy list
--bucket_id <value>

Description

List archiving policies

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
bucket_id required	string	Bucket ID	`138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`

Responses

Name	Description	Example
id	Archiving Policy ID	SCH-XXXXXXX
object_lifecycle	Object LifeCycle	1
object_path	Object Path	/
state	Archiving Policy State	ACTIVE

1.1.10 - ListBucketObjects

1.1.10.1 - 1.1

scpcli archivestorage bucket object list
--bucket_id <value>
[--marker <value>]
[--object_path <value>]
[--object_name <value>]
[--object_type <value>]
[--limit <value>]

Description

List Bucket Objects

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
bucket_id required	string	Bucket ID	`138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`
marker optional	string	Marker	`TODO.txt`
object_path optional	string	Object Path	`/`
object_name optional	string	Object Name	`hello/TODO.txt`
object_type optional	string	Object Type	`FILE`
limit optional	integer	Limit	`20`

Responses

Name	Description	Example
object_name	Object Name	hello/TODO.txt
object_type	Object Type	FILE
object_size	Object Size	3581
modified_at	Modified AT	2025-04-09T05:54:46.244000+00:00

1.1.10.2 - 1.0

scpcli archivestorage bucket object list
--bucket_id <value>
[--marker <value>]
[--object_path <value>]
[--object_name <value>]
[--object_type <value>]
[--limit <value>]

Description

List Bucket Objects

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
bucket_id required	string	Bucket ID	`138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`
marker optional	string	Marker	`TODO.txt`
object_path optional	string	Object Path	`/`
object_name optional	string	Object Name	`hello/TODO.txt`
object_type optional	string	Object Type	`FILE`
limit optional	integer	Limit	`20`

Responses

Name	Description	Example
object_name	Object Name	hello/TODO.txt
object_type	Object Type	FILE
object_size	Object Size	3581
modified_at	Modified AT	2025-04-09T05:54:46.244000+00:00

1.1.11 - ListBucketObjectVersions

1.1.11.1 - 1.1

scpcli archivestorage bucket object version list
--bucket_id <value>
--object_path <value>
[--offset <value>]
[--limit <value>]

Description

List Bucket Object Versions

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
bucket_id required	string	Bucket ID	`138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`
object_path required	string	Object Path	`hello/my_file.txt`
offset optional	integer	Offset	`0`
limit optional	integer	Limit	`20`

Responses

Name	Description	Example
object_path	Object Path	hello/my_file.txt
object_version_id	Object Version Id	Oc9nEYWV.6VjzsIMXFZWM1zL8HcYvKl
latest	Is Latest version of Object	True
modified_at	Modified AT	2025-04-09T05:54:46.244000+00:00
etag	ETag	4f6094f1e0619a6504efcb5e69e63bec
size	Size	20

1.1.12 - ListBuckets

1.1.12.1 - 1.1

scpcli archivestorage bucket list
[--name <value>]
[--limit <value>]

Description

List Buckets

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
name optional	string	Bucket name	`astest`
limit optional	integer	Limit	`20`

Responses

Name	Description	Example
id	Bucket ID	138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
name	Bucket name	astest

1.1.12.2 - 1.0

scpcli archivestorage bucket list
[--name <value>]
[--limit <value>]

Description

List Buckets

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
name optional	string	Bucket name	`astest`
limit optional	integer	Limit	`20`

Responses

Name	Description	Example
id	Bucket ID	138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
name	Bucket name	astest

1.1.13 - ListRecoveryHistories

1.1.13.1 - 1.1

scpcli archivestorage recovery history list
--start_at_to <value>
--start_at_from <value>
--bucket_id <value>
[--state <value>]
[--limit <value>]
[--offset <value>]

Description

List recovery histories

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
start_at_to required	string	Start at to	`2025-04-30T23:59:59+09:00`
start_at_from required	string	Start at from	`2025-04-01T00:00:00+09:00`
bucket_id required	string	Bucket ID	`7d8d8c2b-d02a-421e-a6e3-5b981bfb507f`
state optional	string	State	`SUCCESS`
limit optional	integer	Limit	`20`
offset optional	integer	Offset	`0`

Responses

Name	Description	Example
id	Recovery History ID	EXE-9df439a5-9e6d-46a4-806e-1e9991520763
recovery_id	Recovery ID	ARC-f9eab563-312b-4bbf-a4bf-d377448d66b5
state	State	SUCCESS
recovery_target_bucket_name	Recovery Target Bucket NAME	test-obs-bucket
start_at	Start at	2025-04-01T00:00:00+09:00
end_at	End at	2025-04-30T23:59:59+09:00

1.1.13.2 - 1.0

scpcli archivestorage recovery history list
--start_at_to <value>
--start_at_from <value>
--bucket_id <value>
[--state <value>]
[--limit <value>]
[--offset <value>]

Description

List recovery histories

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
start_at_to required	string	Start at to	`2025-04-30T23:59:59+09:00`
start_at_from required	string	Start at from	`2025-04-01T00:00:00+09:00`
bucket_id required	string	Bucket ID	`7d8d8c2b-d02a-421e-a6e3-5b981bfb507f`
state optional	string	State	`SUCCESS`
limit optional	integer	Limit	`20`
offset optional	integer	Offset	`0`

Responses

Name	Description	Example
id	Recovery History ID	EXE-9df439a5-9e6d-46a4-806e-1e9991520763
recovery_id	Recovery ID	ARC-f9eab563-312b-4bbf-a4bf-d377448d66b5
state	State	SUCCESS
recovery_target_bucket_name	Recovery Target Bucket NAME	test-obs-bucket
start_at	Start at	2025-04-01T00:00:00+09:00
end_at	End at	2025-04-30T23:59:59+09:00

1.1.14 - RecoverObjects

1.1.14.1 - 1.1

scpcli archivestorage bucket object recover
--bucket_id <value>
--overwrite <value>
--recovery_infos <value>
--recovery_target_bucket_name <value>

Description

Recover Objects to objectstorage

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
bucket_id required	string	Bucket ID	`138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`
overwrite required	boolean	Overwrite	`True`
recovery_infos required	array	Object Recovery Info List	`'{"source_object_path": "/", "object_type": "FILE"}'`
recovery_target_bucket_name required	string	Recovery Target Bucket Name	`obs-bucket-name`

1.1.14.2 - 1.0

scpcli archivestorage bucket object recover
--bucket_id <value>
--overwrite <value>
--recovery_infos <value>
--recovery_target_bucket_name <value>

Description

Recover Objects to objectstorage

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
bucket_id required	string	Bucket ID	`138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`
overwrite required	boolean	Overwrite	`True`
recovery_infos required	array	Object Recovery Info List	`'{"source_object_path": "/", "object_type": "FILE"}'`
recovery_target_bucket_name required	string	Recovery Target Bucket Name	`obs-bucket-name`

1.1.15 - RecoverObjectVersions

1.1.15.1 - 1.1

scpcli archivestorage bucket object recover versions
--bucket_id <value>
--overwrite <value>
--source_object_version <value>
--source_object_path <value>
--recovery_target_bucket_name <value>

Description

Recover Object Versions to objectstorage

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
bucket_id required	string	Bucket ID	`138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`
overwrite required	boolean	Overwrite	`True`
source_object_version required	string	Recovery Source Object Version	`Oc9nEYWV.6VjzsIMXFZWM1zL8HcYvKl`
source_object_path required	string	Recovery Source Object Path	`/`
recovery_target_bucket_name required	string	Recovery Target Bucket Name	`obs-bucket-name`

1.1.16 - SetArchivingPolicy

1.1.16.1 - 1.1

scpcli archivestorage archiving policy set
--archiving_policy_id <value>
--bucket_id <value>
--object_lifecycle <value>

Description

Set archivingPolicy

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
archiving_policy_id required	string	Archiving Policy ID	`SCH-XXXXXXX`
bucket_id required	string	Bucket ID	`138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`
object_lifecycle required	string	Object LifeCycle	`1`

1.1.16.2 - 1.0

scpcli archivestorage archiving policy set
--archiving_policy_id <value>
--bucket_id <value>
--object_lifecycle <value>

Description

Set archivingPolicy

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
archiving_policy_id required	string	Archiving Policy ID	`SCH-XXXXXXX`
bucket_id required	string	Bucket ID	`138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`
object_lifecycle required	string	Object LifeCycle	`1`

1.1.17 - SetArchivingPolicyState

1.1.17.1 - 1.1

scpcli archivestorage archiving policy state set
--archiving_policy_id <value>
--bucket_id <value>
--state <value>

Description

Set archivingPolicy state

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
archiving_policy_id required	string	Archiving Policy ID	`SCH-XXXXXXX`
bucket_id required	string	Bucket ID	`138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`
state required	string	Archiving Policy State	`ACTIVE`

1.1.18 - SetBucketEncryption

1.1.18.1 - 1.1

scpcli archivestorage bucket encryption set
--bucket_id <value>
--enabled <value>

Description

Set a specific bucket encryption

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
bucket_id required	string	Bucket ID	`138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`
enabled required	boolean	Encryption Enabled	`True`

1.1.18.2 - 1.0

scpcli archivestorage bucket encryption set
--bucket_id <value>
--enabled <value>

Description

Set a specific bucket encryption

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
bucket_id required	string	Bucket ID	`138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`
enabled required	boolean	Encryption Enabled	`True`

1.1.19 - SetBucketVersioning

1.1.19.1 - 1.1

scpcli archivestorage bucket versioning set
--bucket_id <value>
--enabled <value>

Description

set a specific bucket versioning

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
bucket_id required	string	Bucket ID	`138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`
enabled required	boolean	Versioning Enabled	`True`

1.1.20 - ShowArchivingHistory

1.1.20.1 - 1.1

scpcli archivestorage archiving history show
--bucket_id <value>
--id <value>

Description

Show an archiving history

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
bucket_id required	string	Bucket ID	`3d036efe-f576-48b0-8375-6d3704a95b63`
id required	string	Archiving History ID	`EXE-8f35b491-a060-453b-b825-e78440ca46de`

Responses

Name	Description	Example
source_object_path	Source Object Path	example_source_object_path/
usage	Usage	1024
total_object_count	Total Object Count	100
archiving_object_count	Archiving Object Count	50
archiving_rate	Archiving Rate	100

1.1.20.2 - 1.0

scpcli archivestorage archiving history show
--bucket_id <value>
--id <value>

Description

Show an archiving history

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
bucket_id required	string	Bucket ID	`3d036efe-f576-48b0-8375-6d3704a95b63`
id required	string	Archiving History ID	`EXE-8f35b491-a060-453b-b825-e78440ca46de`

Responses

Name	Description	Example
source_object_path	Source Object Path	example_source_object_path/
usage	Usage	1024
total_object_count	Total Object Count	100
archiving_object_count	Archiving Object Count	50
archiving_rate	Archiving Rate	100

1.1.21 - ShowArchivingPolicy

1.1.21.1 - 1.1

scpcli archivestorage archiving policy show
--archiving_policy_id <value>
--bucket_id <value>

Description

Show an archivingPolicy

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
archiving_policy_id required	string	Archiving Policy ID	`SCH-XXXXXXX`
bucket_id required	string	Bucket ID	`138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`

Responses

Name	Description	Example
id	Archiving Policy ID	SCH-XXXXXXX
bucket_id	Bucket ID	138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
archiving_source	Archiving Source
object_lifecycle	Object LifeCycle	1
state	Archiving Policy State	ACTIVE

1.1.21.2 - 1.0

scpcli archivestorage archiving policy show
--archiving_policy_id <value>
--bucket_id <value>

Description

Show an archivingPolicy

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
archiving_policy_id required	string	Archiving Policy ID	`SCH-XXXXXXX`
bucket_id required	string	Bucket ID	`138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`

Responses

Name	Description	Example
id	Archiving Policy ID	SCH-XXXXXXX
bucket_id	Bucket ID	138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
archiving_source	Archiving Source
object_lifecycle	Object LifeCycle	1
state	Archiving Policy State	ACTIVE

1.1.22 - ShowBucket

1.1.22.1 - 1.1

scpcli archivestorage bucket show
--bucket_id <value>

Description

Show a specific bucket

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
bucket_id required	string	Bucket ID	`138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`

Responses

Name	Description	Example
id	Bucket ID	138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
name	Bucket name	astest
state	Bucket state	ACTIVE
usage	Bucket usage	10
archiving_source_bucket_name	Archiving source bucket name	obstest

1.1.22.2 - 1.0

scpcli archivestorage bucket show
--bucket_id <value>

Description

Show a specific bucket

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
bucket_id required	string	Bucket ID	`138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`

Responses

Name	Description	Example
id	Bucket ID	138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
name	Bucket name	astest
state	Bucket state	ACTIVE
usage	Bucket usage	10
archiving_source_bucket_name	Archiving source bucket name	obstest

1.1.23 - ShowBucketEncryption

1.1.23.1 - 1.1

scpcli archivestorage bucket encryption show
--bucket_id <value>

Description

Show a specific bucket encryption

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
bucket_id required	string	Bucket ID	`138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`

Responses

Name	Description	Example
id	Bucket ID	138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
enabled	Encryption Enabled	True

1.1.23.2 - 1.0

scpcli archivestorage bucket encryption show
--bucket_id <value>

Description

Show a specific bucket encryption

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
bucket_id required	string	Bucket ID	`138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`

Responses

Name	Description	Example
id	Bucket ID	138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
enabled	Encryption Enabled	True

1.1.24 - ShowBucketVersioning

1.1.24.1 - 1.1

scpcli archivestorage bucket versioning show
--bucket_id <value>

Description

show a specific bucket versioning

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
bucket_id required	string	Bucket ID	`138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`

Responses

Name	Description	Example
id	Bucket ID	138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
enabled	Version Enabled	True

1.1.25 - ShowRecoveryHistory

1.1.25.1 - 1.1

scpcli archivestorage recovery history show
--bucket_id <value>
--id <value>

Description

Show a recovery history

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
bucket_id required	string	Bucket ID	`7d8d8c2b-d02a-421e-a6e3-5b981bfb507f`
id required	string	Recovery History ID	`EXE-9df439a5-9e6d-46a4-806e-1e9991520763`

Responses

Name	Description	Example
source_object_path	Source Object Path	example_source_object_path/
usage	Usage	1024
total_object_count	Total Object Count	100
recovery_object_count	Recovery Object Count	50
recovery_rate	Recovery Rate	50

1.1.25.2 - 1.0

scpcli archivestorage recovery history show
--bucket_id <value>
--id <value>

Description

Show a recovery history

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
bucket_id required	string	Bucket ID	`7d8d8c2b-d02a-421e-a6e3-5b981bfb507f`
id required	string	Recovery History ID	`EXE-9df439a5-9e6d-46a4-806e-1e9991520763`

Responses

Name	Description	Example
source_object_path	Source Object Path	example_source_object_path/
usage	Usage	1024
total_object_count	Total Object Count	100
recovery_object_count	Recovery Object Count	50
recovery_rate	Recovery Rate	50

2 - Backup

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 Backup service and how to call CLI.

Version

Version	Status	Supported Until
1.0	DEPRECATED	20260331
1.1	CURRENT	-

2.1 - CLIs

2.1.1 - Check Backup Master Connection State

2.1.1.1 - 1.1

scpcli backup backup agent connection state check
--backup_agent_id <value>

Description

Check Backup master connection state.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
backup_agent_id required	string	Backup Agent ID	`BACKUP_AGENT-abcd`

Responses

Name	Description	Example
request_id	Request ID
resource	Resource

2.1.1.2 - 1.0

scpcli backup backup agent connection state check
--backup_agent_id <value>

Description

Check Backup master connection state.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20260331

Parameters

Name	Type	Description	Example
backup_agent_id required	string	Backup Agent ID	`BACKUP_AGENT-abcd`

Responses

Name	Description	Example
request_id	Request ID
resource	Resource

2.1.2 - Check Backup Name Duplicate

2.1.2.1 - 1.1

scpcli backup backup name duplicate check
--backup_name <value>

Description

Check for duplicate backup names.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
backup_name required	string	Backup name	`backup-001`

Responses

Name	Description	Example
result	Result	True

2.1.2.2 - 1.0

scpcli backup backup name duplicate check
--backup_name <value>

Description

Check for duplicate backup names.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20260331

Parameters

Name	Type	Description	Example
backup_name required	string	Backup name	`backup-001`

Responses

Name	Description	Example
result	Result	True

2.1.3 - Check Backup Restore Server Name Duplicate

2.1.3.1 - 1.1

scpcli backup backup restore server name duplicate check
--restore_server_name <value>

Description

Check for duplicate restore server name.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
restore_server_name required	string	Restore server name	`restoretest1`

Responses

Name	Description	Example
result	Result	True

2.1.3.2 - 1.0

scpcli backup backup restore server name duplicate check
--restore_server_name <value>

Description

Check for duplicate restore server name.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20260331

Parameters

Name	Type	Description	Example
restore_server_name required	string	Restore server name	`restoretest1`

Responses

Name	Description	Example
result	Result	True

2.1.4 - Check Filesystem Path Duplication

2.1.4.1 - 1.1

scpcli backup backup agent filesystem duplication check
--server_uuid <value>
--filesystem_path <value>

Description

Check filesystem path duplication.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
server_uuid required	string	Backup server UUID	`89f5ef44-1021-4a5c-8e06-fbb289eac366`
filesystem_path required	string	Filesystem backup path	`/aaa`

Responses

Name	Description	Example
result	Result	True

2.1.4.2 - 1.0

scpcli backup backup agent filesystem duplication check
--server_uuid <value>
--filesystem_path <value>

Description

Check filesystem path duplication.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20260331

Parameters

Name	Type	Description	Example
server_uuid required	string	Backup server UUID	`89f5ef44-1021-4a5c-8e06-fbb289eac366`
filesystem_path required	string	Filesystem backup path	`/aaa`

Responses

Name	Description	Example
result	Result	True

2.1.5 - Create Backup

2.1.5.1 - 1.1

scpcli backup backup create
--server_uuid <value>
--server_category <value>
--schedules <value>
--policy_type <value>
--policy_category <value>
--name <value>
[--dr_enabled <value>]
[--encrypt_enabled <value>]
[--filesystem_paths <value>]
[--region <value>]
[--retention_period <value>]
[--server_guid <value>]
[--tags <value>]

Description

Create a Backup.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
server_uuid required	string	Backup server UUID	`89f5ef44-1021-4a5c-8e06-fbb289eac366`
server_category required	string	Backup server category	```VIRTUAL_SERVER
schedules required	array	Schedules	`'{"frequency": "DAILY", "start_day": "MON", "start_time": "09:00:00", "start_week": "WEEK_2", "type": "FULL"}'`
policy_type required	string	Backup policy type	`VM_IMAGE`
policy_category required	string	Backup policy category	`AGENTLESS`
name required	string	Backup name	`backup-001`
dr_enabled optional	boolean	Whether to use DR	-
encrypt_enabled optional	boolean	Whether to use Encryption	`True`
filesystem_paths optional	array	List of filesystem backup path	`/aaa`
region optional	string	Region	`kr-west1`
retention_period optional	string	Backup retention period	`WEEK_2`
server_guid optional	string	Backup server GUID	`9ab33c66-3dbd-46cd-b0af-abccd3eb3170`
tags optional	array		`'{"key": "", "value": ""}'`

Responses

Name	Description	Example
request_id	Request ID
resource	Resource

2.1.5.2 - 1.0

scpcli backup backup create
--server_uuid <value>
--server_category <value>
--schedules <value>
--policy_type <value>
--policy_category <value>
--name <value>
[--encrypt_enabled <value>]
[--filesystem_paths <value>]
[--region <value>]
[--retention_period <value>]
[--server_guid <value>]
[--tags <value>]

Description

Create a Backup.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20260331

Parameters

Name	Type	Description	Example
server_uuid required	string	Backup server UUID	`89f5ef44-1021-4a5c-8e06-fbb289eac366`
server_category required	string	Backup server category	```VIRTUAL_SERVER
schedules required	array	Schedules	`'{"frequency": "DAILY", "start_day": "MON", "start_time": "09:00:00", "start_week": "WEEK_2", "type": "FULL"}'`
policy_type required	string	Backup policy type	`VM_IMAGE`
policy_category required	string	Backup policy category	`AGENTLESS`
name required	string	Backup name	`backup-001`
encrypt_enabled optional	boolean	Whether to use Encryption	`True`
filesystem_paths optional	array	List of filesystem backup path	`/aaa`
region optional	string	Region	`kr-west1`
retention_period optional	string	Backup retention period	`WEEK_2`
server_guid optional	string	Backup server GUID	`9ab33c66-3dbd-46cd-b0af-abccd3eb3170`
tags optional	array		`'{"key": "", "value": ""}'`

Responses

Name	Description	Example
request_id	Request ID
resource	Resource

2.1.6 - Create Backup Agent

2.1.6.1 - 1.1

scpcli backup backup agent create
--server_uuid <value>
[--tags <value>]

Description

Create a Backup Agent.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
server_uuid required	string	Backup Agent target server UUID	`89f5ef44-1021-4a5c-8e06-fbb289eac366`
tags optional	array		`'{"key": "", "value": ""}'`

Responses

Name	Description	Example
request_id	Request ID
resource	Resource

2.1.6.2 - 1.0

scpcli backup backup agent create
--server_uuid <value>
[--tags <value>]

Description

Create a Backup Agent.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20260331

Parameters

Name	Type	Description	Example
server_uuid required	string	Backup Agent target server UUID	`89f5ef44-1021-4a5c-8e06-fbb289eac366`
tags optional	array		`'{"key": "", "value": ""}'`

Responses

Name	Description	Example
request_id	Request ID
resource	Resource

2.1.7 - Delete Backup

2.1.7.1 - 1.1

scpcli backup backup delete
--backup_id <value>

Description

Terminate the Backup.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`

2.1.7.2 - 1.0

scpcli backup backup delete
--backup_id <value>

Description

Terminate the Backup.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20260331

Parameters

Name	Type	Description	Example
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`

2.1.8 - Delete Backup Agent

2.1.8.1 - 1.1

scpcli backup backup agent delete
--backup_agent_id <value>

Description

Terminate the Backup Agent.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
backup_agent_id required	string	Backup Agent ID	`BACKUP_AGENT-abcd`

2.1.8.2 - 1.0

scpcli backup backup agent delete
--backup_agent_id <value>

Description

Terminate the Backup Agent.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20260331

Parameters

Name	Type	Description	Example
backup_agent_id required	string	Backup Agent ID	`BACKUP_AGENT-abcd`

2.1.9 - Delete Backup Restore Target

2.1.9.1 - 1.1

scpcli backup backup restore target delete
--backup_id <value>
--restore_target_ids <value>

Description

Delete Backup restore target.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`
restore_target_ids required	array	Backup restore target ID list	`ca1a8e76-af49-40ea-93f8-a5989ffe138b`

2.1.9.2 - 1.0

scpcli backup backup restore target delete
--backup_id <value>
--restore_target_ids <value>

Description

Delete Backup restore target.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20260331

Parameters

Name	Type	Description	Example
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`
restore_target_ids required	array	Backup restore target ID list	`ca1a8e76-af49-40ea-93f8-a5989ffe138b`

2.1.10 - List Agent Backup Restore Target Servers

2.1.10.1 - 1.1

scpcli backup agent backup restore target server list
--backup_id <value>
[--server_name <value>]
[--page <value>]
[--size <value>]

Description

List Agent Backup restore target servers.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`
server_name optional	string	Backup server name	`server-001`
page optional	integer	Page	`0`
size optional	integer	Size	`20`

Responses

Name	Description	Example
server_name	Backup server name	server-001
server_os_version	Server’s OS Type and Version	UBUNTU 22.04
server_uuid	Backup server UUID	89f5ef44-1021-4a5c-8e06-fbb289eac366

2.1.10.2 - 1.0

scpcli backup agent backup restore target server list
--backup_id <value>
[--server_name <value>]
[--page <value>]
[--size <value>]

Description

List Agent Backup restore target servers.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20260331

Parameters

Name	Type	Description	Example
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`
server_name optional	string	Backup server name	`server-001`
page optional	integer	Page	`0`
size optional	integer	Size	`20`

Responses

Name	Description	Example
server_name	Backup server name	server-001
server_os_version	Server’s OS Type and Version	UBUNTU 22.04
server_uuid	Backup server UUID	89f5ef44-1021-4a5c-8e06-fbb289eac366

2.1.11 - List Backup Agents

2.1.11.1 - 1.1

scpcli backup backup agent list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--server_backup_agent_ip <value>]
[--server_name <value>]

Description

List Backup Agents.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
name optional	string	Backup Agent Name	`agent_abcd12`
server_backup_agent_ip optional	string	Server's Backup Agent IP	`11.22.33.44`
server_name optional	string	Backup Agent target server name	`server-001`

Responses

Name	Description	Example
id	Backup Agent ID	BACKUP_AGENT-abcd
account_id	Account ID	fnsd89fus0f9ds09f90dshf9dshfds09
backup_policy_count	Backup policy count	3
connection_state	Backup Agent connection state	SUCCESS
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Backup Agent Name	agent_abcd12
server_backup_agent_ip	Server’s Backup Agent IP	11.22.33.44
server_name	Backup server name	server-001
state	Backup Agent state	AVAILABLE

2.1.11.2 - 1.0

scpcli backup backup agent list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--server_backup_agent_ip <value>]
[--server_name <value>]

Description

List Backup Agents.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20260331

Parameters

Name	Type	Description	Example
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
name optional	string	Backup Agent Name	`agent_abcd12`
server_backup_agent_ip optional	string	Server's Backup Agent IP	`11.22.33.44`
server_name optional	string	Backup Agent target server name	`server-001`

Responses

Name	Description	Example
id	Backup Agent ID	BACKUP_AGENT-abcd
account_id	Account ID	fnsd89fus0f9ds09f90dshf9dshfds09
backup_policy_count	Backup policy count	3
connection_state	Backup Agent connection state	SUCCESS
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Backup Agent Name	agent_abcd12
server_backup_agent_ip	Server’s Backup Agent IP	11.22.33.44
server_name	Backup server name	server-001
state	Backup Agent state	AVAILABLE

2.1.12 - List Backup Histories

2.1.12.1 - 1.1

scpcli backup backup history list
--backup_id <value>
[--backup_start_time <value>]
[--backup_end_time <value>]
[--backup_job_state <value>]
[--page <value>]
[--size <value>]
[--sort <value>]

Description

List Backup histories.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`
backup_start_time optional	string	Start time	`2024-09-30T15:00:00Z`
backup_end_time optional	string	End time	`2024-10-31T14:59:59Z`
backup_job_state optional	****	Backup history state	`SUCCESS`
page optional	integer	Page	`0`
size optional	integer	Size	`20`
sort optional	string	Sort	`backup_start_time:desc`

Responses

Name	Description	Example
backup_end_time	End time	2024-10-31T14:59:59Z
backup_job_guid	Backup job GUID	3b1da7ba-3f38-45cb-9538-e921826f80d7
backup_job_state	Backup history state	SUCCESS
backup_start_time	Start time	2024-09-30T15:00:00Z
schedule_id	Schedule ID	f5b8e22b-0d88-4698-9996-fb44217c8227
schedule_name	Schedule name	INCREMENTAL_DAILY_15:00:00-chg4By

2.1.12.2 - 1.0

scpcli backup backup history list
--backup_id <value>
[--backup_start_time <value>]
[--backup_end_time <value>]
[--backup_job_state <value>]
[--page <value>]
[--size <value>]
[--sort <value>]

Description

List Backup histories.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20260331

Parameters

Name	Type	Description	Example
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`
backup_start_time optional	string	Start time	`2024-09-30T15:00:00Z`
backup_end_time optional	string	End time	`2024-10-31T14:59:59Z`
backup_job_state optional	****	Backup history state	`SUCCESS`
page optional	integer	Page	`0`
size optional	integer	Size	`20`
sort optional	string	Sort	`backup_start_time:desc`

Responses

Name	Description	Example
backup_end_time	End time	2024-10-31T14:59:59Z
backup_job_guid	Backup job GUID	3b1da7ba-3f38-45cb-9538-e921826f80d7
backup_job_state	Backup history state	SUCCESS
backup_start_time	Start time	2024-09-30T15:00:00Z
schedule_id	Schedule ID	f5b8e22b-0d88-4698-9996-fb44217c8227
schedule_name	Schedule name	INCREMENTAL_DAILY_15:00:00-chg4By

2.1.13 - List Backup Region Relationship

2.1.13.1 - 1.1

scpcli backup backup region relationship list
[--from_region <value>]
[--from_availability_zone <value>]
[--to_region <value>]
[--to_availability_zone <value>]
[--backup_master_type <value>]

Description

List Backup Region Relationship.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
from_region optional	string	Region	`kr-west1`
from_availability_zone optional	string	Availability zone name	`kr-west1`
to_region optional	string	Region	`kr-west1`
to_availability_zone optional	string	Availability zone name	`kr-west1`
backup_master_type optional	****	Backup Master type	`AGENTLESS`

Responses

Name	Description	Example
from_availability_zone	Availability zone name	kr-west1
from_region	Region	kr-west1
to_availability_zone	Availability zone name	kr-west1
to_region	Region	kr-west1

2.1.13.2 - 1.0

scpcli backup backup region relationship list
[--from_region <value>]
[--from_availability_zone <value>]
[--to_region <value>]
[--to_availability_zone <value>]

Description

List Backup Region Relationship.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20260331

Parameters

Name	Type	Description	Example
from_region optional	string	Region	`kr-west1`
from_availability_zone optional	string	Availability zone name	`kr-west1`
to_region optional	string	Region	`kr-west1`
to_availability_zone optional	string	Availability zone name	`kr-west1`

Responses

Name	Description	Example
from_availability_zone	Availability zone name	kr-west1
from_region	Region	kr-west1
to_availability_zone	Availability zone name	kr-west1
to_region	Region	kr-west1

2.1.14 - List Backup Restore Histories

2.1.14.1 - 1.1

scpcli backup backup restore history list
--backup_id <value>
[--page <value>]
[--size <value>]
[--sort <value>]
[--restore_state <value>]
[--start_time <value>]
[--end_time <value>]

Description

List Backup restore histories.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`
page optional	integer	Page	`0`
size optional	integer	Size	`20`
sort optional	string	Sort	`backup_start_time:desc`
restore_state optional	****	Restore state	`COMPLETED`
start_time optional	string	Start time	`2024-09-30T15:00:00Z`
end_time optional	string	End time	`2024-10-31T14:59:59Z`

Responses

Name	Description	Example
backup_id	Backup ID	00cd2538fbf94d12b36aabbdd607e974
backup_start_time	Backup time	2024-10-28T05:38:48
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
restore_end_time	Restore completion time	2024-10-28T05:52:47
restore_server_id	Restored server ID	26895cb7-2059-49e7-b6fe-9c9c4b0d3db0
restore_server_name	Restore server name	restoretest1
restore_start_time	Restore start time	2024-10-28T05:52:47
restore_state	Restore state	COMPLETED
schedule_name	Schedule name	INCREMENTAL_DAILY_15:00:00-chg4By

2.1.14.2 - 1.0

scpcli backup backup restore history list
--backup_id <value>
[--page <value>]
[--size <value>]
[--sort <value>]
[--restore_state <value>]
[--start_time <value>]
[--end_time <value>]

Description

List Backup restore histories.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20260331

Parameters

Name	Type	Description	Example
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`
page optional	integer	Page	`0`
size optional	integer	Size	`20`
sort optional	string	Sort	`backup_start_time:desc`
restore_state optional	****	Restore state	`COMPLETED`
start_time optional	string	Start time	`2024-09-30T15:00:00Z`
end_time optional	string	End time	`2024-10-31T14:59:59Z`

Responses

Name	Description	Example
backup_id	Backup ID	00cd2538fbf94d12b36aabbdd607e974
backup_start_time	Backup time	2024-10-28T05:38:48
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
restore_end_time	Restore completion time	2024-10-28T05:52:47
restore_server_id	Restored server ID	26895cb7-2059-49e7-b6fe-9c9c4b0d3db0
restore_server_name	Restore server name	restoretest1
restore_start_time	Restore start time	2024-10-28T05:52:47
restore_state	Restore state	COMPLETED
schedule_name	Schedule name	INCREMENTAL_DAILY_15:00:00-chg4By

2.1.15 - List Backup Restore Subnets

2.1.15.1 - 1.1

scpcli backup backup restore subnet list
--backup_id <value>
--region <value>
[--vpc_id <value>]
[--state <value>]

Description

List of subnets to select when restoring to a different location from the original server.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`
region required	string	Region to restore server	`kr-west1`
vpc_id optional	string	VPC ID	`7df8abb4912e4709b1cb237daccca7a8`
state optional	string	Subnet state	`ACTIVE`

Responses

Name	Description	Example
id	Subnet ID	023c57b14f11483689338d085e061492
account_id	Account ID	fnsd89fus0f9ds09f90dshf9dshfds09
cidr	Subnet Cidr	192.167.1.0/24
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
gateway_ip_address	Gateway IP Address	192.167.1.1
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Subnet Name	subnetName
state	Subnet state	ACTIVE
type	Subnet Type	GENERAL
vpc_id	VPC ID	7df8abb4912e4709b1cb237daccca7a8
vpc_name	VPC name	vpcName

2.1.15.2 - 1.0

scpcli backup backup restore subnet list
--backup_id <value>
--region <value>
[--vpc_id <value>]
[--state <value>]

Description

List of subnets to select when restoring to a different location from the original server.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20260331

Parameters

Name	Type	Description	Example
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`
region required	string	Region to restore server	`kr-west1`
vpc_id optional	string	VPC ID	`7df8abb4912e4709b1cb237daccca7a8`
state optional	string	Subnet state	`ACTIVE`

Responses

Name	Description	Example
id	Subnet ID	023c57b14f11483689338d085e061492
account_id	Account ID	fnsd89fus0f9ds09f90dshf9dshfds09
cidr	Subnet Cidr	192.167.1.0/24
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
gateway_ip_address	Gateway IP Address	192.167.1.1
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Subnet Name	subnetName
state	Subnet state	ACTIVE
type	Subnet Type	GENERAL
vpc_id	VPC ID	7df8abb4912e4709b1cb237daccca7a8
vpc_name	VPC name	vpcName

2.1.16 - List Backup Restore Targets

2.1.16.1 - 1.1

scpcli backup backup restore target list
--backup_id <value>
[--backup_start_time <value>]
[--backup_end_time <value>]
[--page <value>]
[--size <value>]
[--sort <value>]

Description

List Backup restore targets.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`
backup_start_time optional	string	Start time	`2024-09-30T15:00:00Z`
backup_end_time optional	string	End time	`2024-10-31T14:59:59Z`
page optional	integer	Page	`0`
size optional	integer	Size	`20`
sort optional	string	Sort	`backup_start_time:desc`

Responses

Name	Description	Example
backup_start_time	Start time	2024-09-30T15:00:00Z
is_restore_available	Whether restore available	true
restore_target_id	Restore target ID	ca1a8e76-af49-40ea-93f8-a5989ffe138b
retention_period	Backup retention period	WEEK_2
schedule_id	Schedule ID	f5b8e22b-0d88-4698-9996-fb44217c8227
schedule_name	Schedule name	INCREMENTAL_DAILY_15:00:00-chg4By
usage_gb	Backup size(GB)	123.4

2.1.16.2 - 1.0

scpcli backup backup restore target list
--backup_id <value>
[--backup_start_time <value>]
[--backup_end_time <value>]
[--page <value>]
[--size <value>]
[--sort <value>]

Description

List Backup restore targets.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20260331

Parameters

Name	Type	Description	Example
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`
backup_start_time optional	string	Start time	`2024-09-30T15:00:00Z`
backup_end_time optional	string	End time	`2024-10-31T14:59:59Z`
page optional	integer	Page	`0`
size optional	integer	Size	`20`
sort optional	string	Sort	`backup_start_time:desc`

Responses

Name	Description	Example
backup_start_time	Start time	2024-09-30T15:00:00Z
is_restore_available	Whether restore available	true
restore_target_id	Restore target ID	ca1a8e76-af49-40ea-93f8-a5989ffe138b
retention_period	Backup retention period	WEEK_2
schedule_id	Schedule ID	f5b8e22b-0d88-4698-9996-fb44217c8227
schedule_name	Schedule name	INCREMENTAL_DAILY_15:00:00-chg4By
usage_gb	Backup size(GB)	123.4

2.1.17 - List Backup Schedules

2.1.17.1 - 1.1

scpcli backup backup schedule list
--backup_id <value>

Description

List Backup schedules.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
backup_id	Backup ID	00cd2538fbf94d12b36aabbdd607e974
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
frequency	Schedule frequency type	DAILY
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Schedule name	INCREMENTAL_DAILY_15:00:00-chg4By
start_day	Schedule start day	MON
start_time	Schedule start time	14:00:00
start_week	Schedule start week	WEEK_1
state	Backup Schedule state	AVAILABLE
type	Schedule type	FULL

2.1.17.2 - 1.0

scpcli backup backup schedule list
--backup_id <value>

Description

List Backup schedules.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20260331

Parameters

Name	Type	Description	Example
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
backup_id	Backup ID	00cd2538fbf94d12b36aabbdd607e974
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
frequency	Schedule frequency type	DAILY
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Schedule name	INCREMENTAL_DAILY_15:00:00-chg4By
start_day	Schedule start day	MON
start_time	Schedule start time	14:00:00
start_week	Schedule start week	WEEK_1
state	Backup Schedule state	AVAILABLE
type	Schedule type	FULL

2.1.18 - List Backup Targets

2.1.18.1 - 1.1

scpcli backup backup target list
--server_category <value>
[--server_name <value>]
[--region <value>]
[--page <value>]
[--size <value>]

Description

List Backup targets.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
server_category required	****	Backup server category	```VIRTUAL_SERVER
server_name optional	string	Backup server name	`server-001`
region optional	string	Region	`kr-west1`
page optional	integer	Page	`0`
size optional	integer	Size	`20`

Responses

Name	Description	Example
server_guid	Backup server GUID	9ab33c66-3dbd-46cd-b0af-abccd3eb3170
server_name	Backup server name	server-001
server_os_version	Server’s OS Type and Version	UBUNTU 22.04
server_type	Backup server type	s1v1m2
server_uuid	Backup server UUID	89f5ef44-1021-4a5c-8e06-fbb289eac366

2.1.18.2 - 1.0

scpcli backup backup target list
--server_category <value>
[--server_name <value>]
[--region <value>]
[--page <value>]
[--size <value>]

Description

List Backup targets.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20260331

Parameters

Name	Type	Description	Example
server_category required	****	Backup server category	```VIRTUAL_SERVER
server_name optional	string	Backup server name	`server-001`
region optional	string	Region	`kr-west1`
page optional	integer	Page	`0`
size optional	integer	Size	`20`

Responses

Name	Description	Example
server_guid	Backup server GUID	9ab33c66-3dbd-46cd-b0af-abccd3eb3170
server_name	Backup server name	server-001
server_os_version	Server’s OS Type and Version	UBUNTU 22.04
server_type	Backup server type	s1v1m2
server_uuid	Backup server UUID	89f5ef44-1021-4a5c-8e06-fbb289eac366

2.1.19 - List Backups

2.1.19.1 - 1.1

scpcli backup backup list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--server_name <value>]

Description

List Backups.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
name optional	string	Backup name	`backup-001`
server_name optional	string	Backup server name	`server-001`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Backup name	backup-001
policy_type	Backup policy type	VM_IMAGE
retention_period	Backup retention period	WEEK_2
role_type	Backup role type	ORIGINAL
server_name	Backup server name	server-001
state	Backup state	AVAILABLE

2.1.19.2 - 1.0

scpcli backup backup list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--server_name <value>]

Description

List Backups.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20260331

Parameters

Name	Type	Description	Example
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
name optional	string	Backup name	`backup-001`
server_name optional	string	Backup server name	`server-001`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Backup name	backup-001
policy_type	Backup policy type	VM_IMAGE
retention_period	Backup retention period	WEEK_2
role_type	Backup role type	ORIGINAL
server_name	Backup server name	server-001
state	Backup state	AVAILABLE

2.1.20 - List Targets of Backup Agent

2.1.20.1 - 1.1

scpcli backup backup agent target list
--server_category <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--server_name <value>]

Description

List targets of Backup Agent.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
server_category required	string	Backup server category	`BAREMETAL_SERVER`
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	Sort	-
server_name optional	string	Backup server name	`server-001`

Responses

Name	Description	Example
server_backup_agent_ip	Server’s Backup Agent IP	11.22.33.44
server_name	Backup Agent target server name	server-001
server_state	Backup server state	RUNNING
server_uuid	Backup Agent target server UUID	89f5ef44-1021-4a5c-8e06-fbb289eac366

2.1.20.2 - 1.0

scpcli backup backup agent target list
--server_category <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--server_name <value>]

Description

List targets of Backup Agent.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20260331

Parameters

Name	Type	Description	Example
server_category required	string	Backup server category	`BAREMETAL_SERVER`
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	Sort	-
server_name optional	string	Backup server name	`server-001`

Responses

Name	Description	Example
server_backup_agent_ip	Server’s Backup Agent IP	11.22.33.44
server_name	Backup Agent target server name	server-001
server_state	Backup server state	RUNNING
server_uuid	Backup Agent target server UUID	89f5ef44-1021-4a5c-8e06-fbb289eac366

2.1.21 - Manual Backup

2.1.21.1 - 1.1

scpcli backup backup manual backup create
--backup_id <value>

Description

Perform Manual Backup immediately.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`

Responses

Name	Description	Example
request_id	Request ID
resource	Resource

2.1.21.2 - 1.0

scpcli backup backup manual backup create
--backup_id <value>

Description

Perform Manual Backup immediately.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20260331

Parameters

Name	Type	Description	Example
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`

Responses

Name	Description	Example
request_id	Request ID
resource	Resource

2.1.22 - Restore Agent Backup

2.1.22.1 - 1.1

scpcli backup agent backup restore
--backup_id <value>
--restore_target_id <value>
--restore_server_uuid <value>
--filesystem_paths <value>
[--overwrite <value>]

Description

Restore the Backup.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`
restore_target_id required	string	Restore target ID	`ca1a8e76-af49-40ea-93f8-a5989ffe138b`
restore_server_uuid required	string	Restored server ID	`89f5ef44-1021-4a5c-8e06-fbb289eac366`
filesystem_paths required	array	List of filesystem backup path	`'{"destination": "/data", "source": "/data"}'`
overwrite optional	boolean	Overwrite	`True`

Responses

Name	Description	Example
request_id	Request ID
resource	Resource

2.1.22.2 - 1.0

scpcli backup agent backup restore
--backup_id <value>
--restore_target_id <value>
--restore_server_uuid <value>
--filesystem_paths <value>
[--overwrite <value>]

Description

Restore the Backup.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20260331

Parameters

Name	Type	Description	Example
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`
restore_target_id required	string	Restore target ID	`ca1a8e76-af49-40ea-93f8-a5989ffe138b`
restore_server_uuid required	string	Restored server ID	`89f5ef44-1021-4a5c-8e06-fbb289eac366`
filesystem_paths required	array	List of filesystem backup path	`'{"destination": "/data", "source": "/data"}'`
overwrite optional	boolean	Overwrite	`True`

Responses

Name	Description	Example
request_id	Request ID
resource	Resource

2.1.23 - Restore Backup

2.1.23.1 - 1.1

scpcli backup backup restore
--backup_id <value>
--server_type_id <value>
--restore_target_id <value>
--restore_server_name <value>
[--networks <value>]
[--restore_region <value>]
[--security_groups <value>]

Description

Restore the Backup.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`
server_type_id required	string	Server type id	`s1v1m2`
restore_target_id required	string	Restore target ID	`ca1a8e76-af49-40ea-93f8-a5989ffe138b`
restore_server_name required	string	Restore server name	`restoretest1`
networks optional	array	Network info for restore	`'{"subnet_id": "023c57b14f11483689338d085e061492"}'`
restore_region optional	string	Region to restore server	`kr-west1`
security_groups optional	array	Security Group ID list	`023c57b14f11483689338d085e061492`

Responses

Name	Description	Example
request_id	Request ID
resource	Resource

2.1.23.2 - 1.0

scpcli backup backup restore
--backup_id <value>
--server_type_id <value>
--restore_target_id <value>
--restore_server_name <value>
[--networks <value>]
[--restore_region <value>]
[--security_groups <value>]

Description

Restore the Backup.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20260331

Parameters

Name	Type	Description	Example
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`
server_type_id required	string	Server type id	`s1v1m2`
restore_target_id required	string	Restore target ID	`ca1a8e76-af49-40ea-93f8-a5989ffe138b`
restore_server_name required	string	Restore server name	`restoretest1`
networks optional	array	Network info for restore	`'{"subnet_id": "023c57b14f11483689338d085e061492"}'`
restore_region optional	string	Region to restore server	`kr-west1`
security_groups optional	array	Security Group ID list	`023c57b14f11483689338d085e061492`

Responses

Name	Description	Example
request_id	Request ID
resource	Resource

2.1.24 - Set Backup Schedule

2.1.24.1 - 1.1

scpcli backup backup schedule set
--backup_id <value>
--schedules <value>

Description

Set Backup schedule.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`
schedules required	array	Backup schedule list	`'{"frequency": "DAILY", "start_day": "MON", "start_time": "09:00:00", "start_week": "WEEK_2", "type": "FULL"}'`

2.1.24.2 - 1.0

scpcli backup backup schedule set
--backup_id <value>
--schedules <value>

Description

Set Backup schedule.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20260331

Parameters

Name	Type	Description	Example
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`
schedules required	array	Backup schedule list	`'{"frequency": "DAILY", "start_day": "MON", "start_time": "09:00:00", "start_week": "WEEK_2", "type": "FULL"}'`

2.1.25 - Set Filesystem Path

2.1.25.1 - 1.1

scpcli backup backup agent filesystem path set
--backup_id <value>
--backup_filesystem_paths <value>

Description

Set Filesystem path.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`
backup_filesystem_paths required	array	List of filesystem backup path	`/aaa`

2.1.25.2 - 1.0

scpcli backup backup agent filesystem path set
--backup_id <value>
--backup_filesystem_paths <value>

Description

Set Filesystem path.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20260331

Parameters

Name	Type	Description	Example
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`
backup_filesystem_paths required	array	List of filesystem backup path	`/aaa`

2.1.26 - Show Backup

2.1.26.1 - 1.1

scpcli backup backup show
--backup_id <value>

Description

Show the detail of Backup.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
backup_agent_id	Backup Agent ID	BACKUP_AGENT-abcd
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
dr_enabled	Whether to use DR
dr_region	DR Region	kr-west1
encrypt_enabled	Whether to use Encryption	False
filesystem_paths	List of filesystem backup path	[’/aaa’, ‘/bbb’]
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Backup name	backup-001
origin_backup_id	Backup ID	00cd2538fbf94d12b36aabbdd607e974
policy_category	Backup policy category	AGENTLESS
policy_type	Backup policy type	VM_IMAGE
region	Region	kr-west1
replica_backup_id	Backup ID	00cd2538fbf94d12b36aabbdd607e974
retention_period	Backup retention period	WEEK_2
role_type	Backup role type	ORIGINAL
server_category	Backup server category	VIRTUAL_SERVER
server_name	Backup server name	server-001
server_os_type	Server’s OS Type	WINDOWS
server_region	Region	kr-west1
server_uuid	Backup server UUID	89f5ef44-1021-4a5c-8e06-fbb289eac366
state	Backup state	AVAILABLE

2.1.26.2 - 1.0

scpcli backup backup show
--backup_id <value>

Description

Show the detail of Backup.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20260331

Parameters

Name	Type	Description	Example
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
backup_agent_id	Backup Agent ID	BACKUP_AGENT-abcd
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
encrypt_enabled	Whether to use Encryption	False
filesystem_paths	List of filesystem backup path	[’/aaa’, ‘/bbb’]
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Backup name	backup-001
policy_category	Backup policy category	AGENTLESS
policy_type	Backup policy type	VM_IMAGE
region	Region	kr-west1
retention_period	Backup retention period	WEEK_2
role_type	Backup role type	ORIGINAL
server_category	Backup server category	VIRTUAL_SERVER
server_name	Backup server name	server-001
server_os_type	Server’s OS Type	WINDOWS
server_region	Region	kr-west1
server_uuid	Backup server UUID	89f5ef44-1021-4a5c-8e06-fbb289eac366
state	Backup state	AVAILABLE

2.1.27 - Show Backup Agent

2.1.27.1 - 1.1

scpcli backup backup agent show
--backup_agent_id <value>

Description

Show the detail of Backup Agent.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
backup_agent_id required	string	Backup Agent ID	`BACKUP_AGENT-abcd`

Responses

Name	Description	Example
id	Backup Agent ID	BACKUP_AGENT-abcd
account_id	Account ID	fnsd89fus0f9ds09f90dshf9dshfds09
backup_master_ip	Backup Master IP	33.44.55.66
backup_master_name	Backup Master name	backupmastertest
backup_policy_count	Backup policy count	3
connection_check_time	Backup Agent connection check time	2024-11-11T09:13:48Z
connection_state	Backup Agent connection state	SUCCESS
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
install_file_path	Install file path	http://linux-agent
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Backup Agent Name	agent_abcd12
server_backup_agent_ip	Server’s Backup Agent IP	11.22.33.44
server_category	Backup server category	VIRTUAL_SERVER
server_gateway_ip	Server Gateway IP	22.33.44.55
server_name	Backup Agent target server name	server-001
server_os_type	Server’s OS Type	WINDOWS
server_uuid	Backup Agent target server UUID	89f5ef44-1021-4a5c-8e06-fbb289eac366
state	Backup Agent state	AVAILABLE

2.1.27.2 - 1.0

scpcli backup backup agent show
--backup_agent_id <value>

Description

Show the detail of Backup Agent.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20260331

Parameters

Name	Type	Description	Example
backup_agent_id required	string	Backup Agent ID	`BACKUP_AGENT-abcd`

Responses

Name	Description	Example
id	Backup Agent ID	BACKUP_AGENT-abcd
account_id	Account ID	fnsd89fus0f9ds09f90dshf9dshfds09
backup_master_ip	Backup Master IP	33.44.55.66
backup_master_name	Backup Master name	backupmastertest
backup_policy_count	Backup policy count	3
connection_check_time	Backup Agent connection check time	2024-11-11T09:13:48Z
connection_state	Backup Agent connection state	SUCCESS
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
install_file_path	Install file path	http://linux-agent
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Backup Agent Name	agent_abcd12
server_backup_agent_ip	Server’s Backup Agent IP	11.22.33.44
server_category	Backup server category	VIRTUAL_SERVER
server_gateway_ip	Server Gateway IP	22.33.44.55
server_name	Backup Agent target server name	server-001
server_os_type	Server’s OS Type	WINDOWS
server_uuid	Backup Agent target server UUID	89f5ef44-1021-4a5c-8e06-fbb289eac366
state	Backup Agent state	AVAILABLE

2.1.28 - Show Backup Agent Install File Path

2.1.28.1 - 1.1

scpcli backup backup agent install file path show
--os_type <value>

Description

Show Backup Agent Install File Path.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
os_type required	string	OS type	-

Responses

Name	Description	Example
install_file_path	Install file path	http://linux-agent

2.1.28.2 - 1.0

scpcli backup backup agent install file path show
--os_type <value>

Description

Show Backup Agent Install File Path.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20260331

Parameters

Name	Type	Description	Example
os_type required	string	OS type	-

Responses

Name	Description	Example
install_file_path	Install file path	http://linux-agent

2.1.29 - Update Replication Use

2.1.29.1 - 1.1

scpcli backup backup replication use set
--backup_id <value>
--dr_enabled <value>

Description

Update Replication use.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`
dr_enabled required	boolean	Whether to use DR	`False`

2.1.29.2 - 1.0

scpcli backup backup replication use set
--backup_id <value>
--dr_enabled <value>

Description

Update Replication use.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20260331

Parameters

Name	Type	Description	Example
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`
dr_enabled required	boolean	Whether to use DR	`False`

2.1.30 - Update Retention Period

2.1.30.1 - 1.1

scpcli backup backup retention period set
--backup_id <value>
--retention_period <value>

Description

Update the retention period.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`
retention_period required	string	Backup retention period	`WEEK_2`

2.1.30.2 - 1.0

scpcli backup backup retention period set
--backup_id <value>
--retention_period <value>

Description

Update the retention period.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20260331

Parameters

Name	Type	Description	Example
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`
retention_period required	string	Backup retention period	`WEEK_2`

3 - 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

Version	Status	Supported Until
1.0	DEPRECATED	20251231
1.1	DEPRECATED	20260331
1.2	CURRENT	-

3.1 - CLIs

3.1.1 - Add Volume Group Member on Volume Group

3.1.1.1 - 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 (CURRENT)

Version	Supported Until
1.2	-

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`

3.1.1.2 - 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)

Version	Supported Until
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`

3.1.1.3 - 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)

Version	Supported Until
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`

3.1.2 - Attach Volume

3.1.2.1 - 1.2

scpcli baremetal-blockstorage volume attachment create
--volume_id <value>
--attachments <value>

Description

Attach Volume to servers.

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

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

3.1.2.2 - 1.1

scpcli baremetal-blockstorage volume attachment create
--volume_id <value>
--attachments <value>

Description

Attach Volume to servers.

State ACTIVE (DEPRECATED)

Version	Supported Until
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

3.1.2.3 - 1.0

scpcli baremetal-blockstorage volume attachment create
--volume_id <value>
--attachments <value>

Description

Attach Volume to servers.

State ACTIVE (DEPRECATED)

Version	Supported Until
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

3.1.3 - Create Volume

3.1.3.1 - 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 (CURRENT)

Version	Supported Until
1.2	-

Parameters

Name	Type	Description	Example
throughput required	integer	Enter the value between at least 125MB/s and up to 1,000MB/s.	`125`
iops required	integer	Enter the value between at least 3,000 IOPS and up to 16,000 IOPS.	`3000`
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

3.1.3.2 - 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)

Version	Supported Until
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

3.1.3.3 - 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)

Version	Supported Until
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

3.1.4 - Create Volume Group

3.1.4.1 - 1.2

scpcli baremetal-blockstorage volume-group create
--volume_ids <value>
--name <value>
[--tags <value>]

Description

Create Volume Group

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

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

3.1.4.2 - 1.1

scpcli baremetal-blockstorage volume-group create
--volume_ids <value>
--name <value>
[--tags <value>]

Description

Create Volume Group

State ACTIVE (DEPRECATED)

Version	Supported Until
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

3.1.4.3 - 1.0

scpcli baremetal-blockstorage volume-group create
--volume_ids <value>
--name <value>
[--tags <value>]

Description

Create Volume Group

State ACTIVE (DEPRECATED)

Version	Supported Until
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

3.1.5 - Create Volume Group Recovery

3.1.5.1 - 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 (CURRENT)

Version	Supported Until
1.2	-

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

3.1.5.2 - 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)

Version	Supported Until
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

3.1.6 - Create Volume Group Replication

3.1.6.1 - 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 (CURRENT)

Version	Supported Until
1.2	-

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

3.1.6.2 - 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)

Version	Supported Until
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

3.1.6.3 - 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)

Version	Supported Until
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

3.1.7 - Create Volume Group Snapshot

3.1.7.1 - 1.2

scpcli baremetal-blockstorage volume-group snapshot create
--volume_group_id <value>

Description

Create Volume Group Snapshot

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

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

3.1.7.2 - 1.1

scpcli baremetal-blockstorage volume-group snapshot create
--volume_group_id <value>

Description

Create Volume Group Snapshot

State ACTIVE (DEPRECATED)

Version	Supported Until
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

3.1.7.3 - 1.0

scpcli baremetal-blockstorage volume-group snapshot create
--volume_group_id <value>

Description

Create Volume Group Snapshot

State ACTIVE (DEPRECATED)

Version	Supported Until
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

3.1.8 - Create Volume Group Snapshot Schedule

3.1.8.1 - 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 (CURRENT)

Version	Supported Until
1.2	-

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

3.1.8.2 - 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)

Version	Supported Until
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

3.1.8.3 - 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)

Version	Supported Until
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

3.1.9 - Create Volume Recovery

3.1.9.1 - 1.2

scpcli baremetal-blockstorage volume recovery create
--volume_id <value>
--snapshot_id <value>
--name <value>

Description

Create Volume Recovery.

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

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

3.1.9.2 - 1.1

scpcli baremetal-blockstorage volume recovery create
--volume_id <value>
--snapshot_id <value>
--name <value>

Description

Create Volume Recovery.

State ACTIVE (DEPRECATED)

Version	Supported Until
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

3.1.10 - Create Volume Replication

3.1.10.1 - 1.2

scpcli baremetal-blockstorage volume replication create
--volume_id <value>
--region <value>
--name <value>
--cycle <value>

Description

Create Volume Replication.

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

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

3.1.10.2 - 1.1

scpcli baremetal-blockstorage volume replication create
--volume_id <value>
--region <value>
--name <value>
--cycle <value>

Description

Create Volume Replication.

State ACTIVE (DEPRECATED)

Version	Supported Until
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

3.1.10.3 - 1.0

scpcli baremetal-blockstorage volume replication create
--volume_id <value>
--region <value>
--name <value>
--cycle <value>

Description

Create Volume Replication.

State ACTIVE (DEPRECATED)

Version	Supported Until
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

3.1.11 - Create Volume Snapshot

3.1.11.1 - 1.2

scpcli baremetal-blockstorage volume snapshot create
--volume_id <value>

Description

Create Volume snapshot.

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

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

3.1.11.2 - 1.1

scpcli baremetal-blockstorage volume snapshot create
--volume_id <value>

Description

Create Volume snapshot.

State ACTIVE (DEPRECATED)

Version	Supported Until
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

3.1.11.3 - 1.0

scpcli baremetal-blockstorage volume snapshot create
--volume_id <value>

Description

Create Volume snapshot.

State ACTIVE (DEPRECATED)

Version	Supported Until
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

3.1.12 - Create Volume Snapshot Rate

3.1.12.1 - 1.2

scpcli baremetal-blockstorage volume snapshot-rate create
--volume_id <value>
--snapshot_rate <value>

Description

Create Volume snapshot rate.

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

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

3.1.12.2 - 1.1

scpcli baremetal-blockstorage volume snapshot-rate create
--volume_id <value>
--snapshot_rate <value>

Description

Create Volume snapshot rate.

State ACTIVE (DEPRECATED)

Version	Supported Until
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

3.1.12.3 - 1.0

scpcli baremetal-blockstorage volume snapshot-rate create
--volume_id <value>
--snapshot_rate <value>

Description

Create Volume snapshot rate.

State ACTIVE (DEPRECATED)

Version	Supported Until
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

3.1.13 - Create Volume Snapshot Schedule

3.1.13.1 - 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 (CURRENT)

Version	Supported Until
1.2	-

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

3.1.13.2 - 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)

Version	Supported Until
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

3.1.13.3 - 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)

Version	Supported Until
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

3.1.14 - Delete Volume

3.1.14.1 - 1.2

scpcli baremetal-blockstorage volume delete
--volume_id <value>

Description

Delete Volume.

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Name	Type	Description	Example
volume_id required	string	Volume id	`92cd16fe8ebc4f73832513a172bf0000`

3.1.14.2 - 1.1

scpcli baremetal-blockstorage volume delete
--volume_id <value>

Description

Delete Volume.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260331

Parameters

Name	Type	Description	Example
volume_id required	string	Volume id	`92cd16fe8ebc4f73832513a172bf0000`

3.1.14.3 - 1.0

scpcli baremetal-blockstorage volume delete
--volume_id <value>

Description

Delete Volume.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
volume_id required	string	Volume id	`92cd16fe8ebc4f73832513a172bf0000`

3.1.15 - Delete Volume Group Replication

3.1.15.1 - 1.2

scpcli baremetal-blockstorage volume-group replication delete
--volume_group_id <value>

Description

Delete Volume Group Replication.

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Name	Type	Description	Example
volume_group_id required	string	Volume group id	`c9ecae8b973b425c81c3817893cd8063`

3.1.15.2 - 1.1

scpcli baremetal-blockstorage volume-group replication delete
--volume_group_id <value>

Description

Delete Volume Group Replication.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260331

Parameters

Name	Type	Description	Example
volume_group_id required	string	Volume group id	`c9ecae8b973b425c81c3817893cd8063`

3.1.15.3 - 1.0

scpcli baremetal-blockstorage volume-group replication delete
--volume_group_id <value>

Description

Delete Volume Group Replication.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
volume_group_id required	string	Volume group id	`c9ecae8b973b425c81c3817893cd8063`

3.1.16 - Delete Volume Group Snapshot

3.1.16.1 - 1.2

scpcli baremetal-blockstorage volume-group snapshot delete
--snapshot_id <value>
--volume_group_id <value>

Description

Delete Volume Group snapshot.

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

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`

3.1.16.2 - 1.1

scpcli baremetal-blockstorage volume-group snapshot delete
--snapshot_id <value>
--volume_group_id <value>

Description

Delete Volume Group snapshot.

State ACTIVE (DEPRECATED)

Version	Supported Until
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`

3.1.16.3 - 1.0

scpcli baremetal-blockstorage volume-group snapshot delete
--snapshot_id <value>
--volume_group_id <value>

Description

Delete Volume Group snapshot.

State ACTIVE (DEPRECATED)

Version	Supported Until
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`

3.1.17 - Delete Volume Group Snapshot Schedule

3.1.17.1 - 1.2

scpcli baremetal-blockstorage volume-group snapshot-schedule delete
--volume_group_id <value>

Description

Delete Volume Group Snapshot Schedule.

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Name	Type	Description	Example
volume_group_id required	string	Volume group id	`c9ecae8b973b425c81c3817893cd8063`

3.1.17.2 - 1.1

scpcli baremetal-blockstorage volume-group snapshot-schedule delete
--volume_group_id <value>

Description

Delete Volume Group Snapshot Schedule.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260331

Parameters

Name	Type	Description	Example
volume_group_id required	string	Volume group id	`c9ecae8b973b425c81c3817893cd8063`

3.1.17.3 - 1.0

scpcli baremetal-blockstorage volume-group snapshot-schedule delete
--volume_group_id <value>

Description

Delete Volume Group Snapshot Schedule.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
volume_group_id required	string	Volume group id	`c9ecae8b973b425c81c3817893cd8063`

3.1.18 - Delete Volume Replication

3.1.18.1 - 1.2

scpcli baremetal-blockstorage volume replication delete
--volume_id <value>

Description

Delete Volume Replication.

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Name	Type	Description	Example
volume_id required	string	Volume id	`92cd16fe8ebc4f73832513a172bf0000`

3.1.18.2 - 1.1

scpcli baremetal-blockstorage volume replication delete
--volume_id <value>

Description

Delete Volume Replication.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260331

Parameters

Name	Type	Description	Example
volume_id required	string	Volume id	`92cd16fe8ebc4f73832513a172bf0000`

3.1.18.3 - 1.0

scpcli baremetal-blockstorage volume replication delete
--volume_id <value>

Description

Delete Volume Replication.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
volume_id required	string	Volume id	`92cd16fe8ebc4f73832513a172bf0000`

3.1.19 - Delete Volume Snapshot

3.1.19.1 - 1.2

scpcli baremetal-blockstorage volume snapshot delete
--snapshot_id <value>
--volume_id <value>

Description

Delete Volume snapshot.

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Name	Type	Description	Example
snapshot_id required	string	Snapshot id	`05600123-6e78-11f0-a3f0-d039eab8d501`
volume_id required	string	Volume id	`92cd16fe8ebc4f73832513a172bf0000`

3.1.19.2 - 1.1

scpcli baremetal-blockstorage volume snapshot delete
--snapshot_id <value>
--volume_id <value>

Description

Delete Volume snapshot.

State ACTIVE (DEPRECATED)

Version	Supported Until
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`

3.1.19.3 - 1.0

scpcli baremetal-blockstorage volume snapshot delete
--snapshot_id <value>
--volume_id <value>

Description

Delete Volume snapshot.

State ACTIVE (DEPRECATED)

Version	Supported Until
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`

3.1.20 - Delete Volume Snapshot Rate

3.1.20.1 - 1.2

scpcli baremetal-blockstorage volume snapshot-rate delete
--volume_id <value>

Description

Delete Volume snapshot rate.

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Name	Type	Description	Example
volume_id required	string	Volume id	`92cd16fe8ebc4f73832513a172bf0000`

3.1.20.2 - 1.1

scpcli baremetal-blockstorage volume snapshot-rate delete
--volume_id <value>

Description

Delete Volume snapshot rate.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260331

Parameters

Name	Type	Description	Example
volume_id required	string	Volume id	`92cd16fe8ebc4f73832513a172bf0000`

3.1.20.3 - 1.0

scpcli baremetal-blockstorage volume snapshot-rate delete
--volume_id <value>

Description

Delete Volume snapshot rate.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
volume_id required	string	Volume id	`92cd16fe8ebc4f73832513a172bf0000`

3.1.21 - Delete Volume Snapshot Schedule

3.1.21.1 - 1.2

scpcli baremetal-blockstorage volume snapshot-schedule delete
--volume_id <value>

Description

Delete Volume snapshot schedule.

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Name	Type	Description	Example
volume_id required	string	Volume id	`92cd16fe8ebc4f73832513a172bf0000`

3.1.21.2 - 1.1

scpcli baremetal-blockstorage volume snapshot-schedule delete
--volume_id <value>

Description

Delete Volume snapshot schedule.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260331

Parameters

Name	Type	Description	Example
volume_id required	string	Volume id	`92cd16fe8ebc4f73832513a172bf0000`

3.1.21.3 - 1.0

scpcli baremetal-blockstorage volume snapshot-schedule delete
--volume_id <value>

Description

Delete Volume snapshot schedule.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
volume_id required	string	Volume id	`92cd16fe8ebc4f73832513a172bf0000`

3.1.22 - Detach Volume

3.1.22.1 - 1.2

scpcli baremetal-blockstorage volume attachment delete
--volume_id <value>
--attachments <value>

Description

Detach Volume from servers.

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Name	Type	Description	Example
volume_id required	string	Volume id	`92cd16fe8ebc4f73832513a172bf0000`
attachments required	array	List of object id to detach	-

3.1.22.2 - 1.1

scpcli baremetal-blockstorage volume attachment delete
--volume_id <value>
--attachments <value>

Description

Detach Volume from servers.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260331

Parameters

Name	Type	Description	Example
volume_id required	string	Volume id	`92cd16fe8ebc4f73832513a172bf0000`
attachments required	array	List of object id to detach	-

3.1.22.3 - 1.0

scpcli baremetal-blockstorage volume attachment delete
--volume_id <value>
--attachments <value>

Description

Detach Volume from servers.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
volume_id required	string	Volume id	`92cd16fe8ebc4f73832513a172bf0000`
attachments required	array	List of object id to detach	-

3.1.23 - List Volume Group Snapshots

3.1.23.1 - 1.2

scpcli baremetal-blockstorage volume-group snapshot list
--volume_group_id <value>

Description

Get a list of Volume Group snapshots.

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

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

3.1.23.2 - 1.1

scpcli baremetal-blockstorage volume-group snapshot list
--volume_group_id <value>

Description

Get a list of Volume Group snapshots.

State ACTIVE (DEPRECATED)

Version	Supported Until
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

3.1.23.3 - 1.0

scpcli baremetal-blockstorage volume-group snapshot list
--volume_group_id <value>

Description

Get a list of Volume Group snapshots.

State ACTIVE (DEPRECATED)

Version	Supported Until
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

3.1.24 - List Volume Groups

3.1.24.1 - 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 (CURRENT)

Version	Supported Until
1.2	-

Parameters

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

Responses

Name	Description	Example
id	Volume group id	c9ecae8b973b425c81c3817893cd8063
account_id	Account id	36827d9b643f46c2ae6bb7e63d633bfe
created_at	Created at	2024-08-01T07:06:23.315Z
created_by	Created by	samsung-cloud-platform1@samsung.com
modified_at	Modified at	2024-08-01T07:06:25.315Z
modified_by	Modified by	samsung-cloud-platform2@samsung.com
name	Volume group name	vg-01
num_of_block_storages	Number of volumes	2
purpose	Volume group purpose	ORG
state	Current state

3.1.24.2 - 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)

Version	Supported Until
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

3.1.24.3 - 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)

Version	Supported Until
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

3.1.25 - List Volume Snapshots

3.1.25.1 - 1.2

scpcli baremetal-blockstorage volume snapshot list
--volume_id <value>

Description

Get a list of Volume snapshots.

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

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

3.1.25.2 - 1.1

scpcli baremetal-blockstorage volume snapshot list
--volume_id <value>

Description

Get a list of Volume snapshots.

State ACTIVE (DEPRECATED)

Version	Supported Until
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

3.1.25.3 - 1.0

scpcli baremetal-blockstorage volume snapshot list
--volume_id <value>

Description

Get a list of Volume snapshots.

State ACTIVE (DEPRECATED)

Version	Supported Until
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

3.1.26 - List Volumes

3.1.26.1 - 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 (CURRENT)

Version	Supported Until
1.2	-

Parameters

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

Responses

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

3.1.26.2 - 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)

Version	Supported Until
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

3.1.26.3 - 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)

Version	Supported Until
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

3.1.27 - Remove Volume Group Member on Volume Group

3.1.27.1 - 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 (CURRENT)

Version	Supported Until
1.2	-

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`

3.1.27.2 - 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)

Version	Supported Until
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`

3.1.27.3 - 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)

Version	Supported Until
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`

3.1.28 - Restore Volume Group Snapshot

3.1.28.1 - 1.2

scpcli baremetal-blockstorage volume-group snapshot restore
--snapshot_id <value>
--volume_group_id <value>

Description

Restore Volume Group snapshot.

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

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`

3.1.28.2 - 1.1

scpcli baremetal-blockstorage volume-group snapshot restore
--snapshot_id <value>
--volume_group_id <value>

Description

Restore Volume Group snapshot.

State ACTIVE (DEPRECATED)

Version	Supported Until
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`

3.1.28.3 - 1.0

scpcli baremetal-blockstorage volume-group snapshot restore
--snapshot_id <value>
--volume_group_id <value>

Description

Restore Volume Group snapshot.

State ACTIVE (DEPRECATED)

Version	Supported Until
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`

3.1.29 - Restore Volume Snapshot

3.1.29.1 - 1.2

scpcli baremetal-blockstorage volume snapshot restore
--snapshot_id <value>
--volume_id <value>

Description

Restore Volume from snapshot.

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Name	Type	Description	Example
snapshot_id required	string	Snapshot id	`05600123-6e78-11f0-a3f0-d039eab8d501`
volume_id required	string	Volume id	`92cd16fe8ebc4f73832513a172bf0000`

3.1.29.2 - 1.1

scpcli baremetal-blockstorage volume snapshot restore
--snapshot_id <value>
--volume_id <value>

Description

Restore Volume from snapshot.

State ACTIVE (DEPRECATED)

Version	Supported Until
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`

3.1.29.3 - 1.0

scpcli baremetal-blockstorage volume snapshot restore
--snapshot_id <value>
--volume_id <value>

Description

Restore Volume from snapshot.

State ACTIVE (DEPRECATED)

Version	Supported Until
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`

3.1.30 - Set Volume Group Replication Cycle

3.1.30.1 - 1.2

scpcli baremetal-blockstorage volume-group replication-cycle set
--volume_group_id <value>
--cycle <value>

Description

Set Volume Group Replication Cycle.

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Name	Type	Description	Example
volume_group_id required	string	Volume group id	`c9ecae8b973b425c81c3817893cd8063`
cycle required	string	Replication cycle	-

3.1.30.2 - 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)

Version	Supported Until
1.1	20260331

Parameters

Name	Type	Description	Example
volume_group_id required	string	Volume group id	`c9ecae8b973b425c81c3817893cd8063`
cycle required	string	Replication cycle	-

3.1.30.3 - 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)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
volume_group_id required	string	Volume group id	`c9ecae8b973b425c81c3817893cd8063`
cycle required	string	Replication cycle	-

3.1.31 - Set Volume Group Replication Policy

3.1.31.1 - 1.2

scpcli baremetal-blockstorage volume-group replication-policy set
--volume_group_id <value>
--policy <value>

Description

Set Volume Group Replication Policy.

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Name	Type	Description	Example
volume_group_id required	string	Volume group id	`c9ecae8b973b425c81c3817893cd8063`
policy required	string	Policy	-

3.1.31.2 - 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)

Version	Supported Until
1.1	20260331

Parameters

Name	Type	Description	Example
volume_group_id required	string	Volume group id	`c9ecae8b973b425c81c3817893cd8063`
policy required	string	Policy	-

3.1.31.3 - 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)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
volume_group_id required	string	Volume group id	`c9ecae8b973b425c81c3817893cd8063`
policy required	string	Policy	-

3.1.32 - Set Volume Group Snapshot Schedule

3.1.32.1 - 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 (CURRENT)

Version	Supported Until
1.2	-

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.)	-

3.1.32.2 - 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)

Version	Supported Until
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.)	-

3.1.32.3 - 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)

Version	Supported Until
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.)	-

3.1.33 - Set Volume QoS

3.1.33.1 - 1.2

scpcli baremetal-blockstorage volume qos set
--volume_id <value>
[--iops <value>]
[--throughput <value>]

Description

Change volume QoS

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Name	Type	Description	Example
volume_id required	string	Volume id	`92cd16fe8ebc4f73832513a172bf0000`
iops optional	integer	IOPS. If omitted, the existing value will be retained.	`3000`
throughput optional	integer	Throughput. If omitted, the existing value will be retained.	`125`

3.1.34 - Set Volume Replication Cycle

3.1.34.1 - 1.2

scpcli baremetal-blockstorage volume replication-cycle set
--volume_id <value>
--cycle <value>

Description

Set Volume Replication Cycle.

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Name	Type	Description	Example
volume_id required	string	Volume id	`92cd16fe8ebc4f73832513a172bf0000`
cycle required	string	Replication cycle	`5MIN`

3.1.34.2 - 1.1

scpcli baremetal-blockstorage volume replication-cycle set
--volume_id <value>
--cycle <value>

Description

Set Volume Replication Cycle.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260331

Parameters

Name	Type	Description	Example
volume_id required	string	Volume id	`92cd16fe8ebc4f73832513a172bf0000`
cycle required	string	Replication cycle	`5MIN`

3.1.34.3 - 1.0

scpcli baremetal-blockstorage volume replication-cycle set
--volume_id <value>
--cycle <value>

Description

Set Volume Replication Cycle.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
volume_id required	string	Volume id	`92cd16fe8ebc4f73832513a172bf0000`
cycle required	string	Replication cycle	`5MIN`

3.1.35 - Set Volume Replication Policy

3.1.35.1 - 1.2

scpcli baremetal-blockstorage volume replication-policy set
--volume_id <value>
--policy <value>

Description

Set Volume Replication Policy.

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Name	Type	Description	Example
volume_id required	string	Volume id	`92cd16fe8ebc4f73832513a172bf0000`
policy required	string	Policy	-

3.1.35.2 - 1.1

scpcli baremetal-blockstorage volume replication-policy set
--volume_id <value>
--policy <value>

Description

Set Volume Replication Policy.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260331

Parameters

Name	Type	Description	Example
volume_id required	string	Volume id	`92cd16fe8ebc4f73832513a172bf0000`
policy required	string	Policy	-

3.1.35.3 - 1.0

scpcli baremetal-blockstorage volume replication-policy set
--volume_id <value>
--policy <value>

Description

Set Volume Replication Policy.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
volume_id required	string	Volume id	`92cd16fe8ebc4f73832513a172bf0000`
policy required	string	Policy	-

3.1.36 - Set Volume Snapshot Rate

3.1.36.1 - 1.2

scpcli baremetal-blockstorage volume snapshot-rate set
--volume_id <value>
--snapshot_rate <value>

Description

Set Volume snapshot rate.

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Name	Type	Description	Example
volume_id required	string	Volume id	`92cd16fe8ebc4f73832513a172bf0000`
snapshot_rate required	integer	Snapshot rate	`100`

3.1.36.2 - 1.1

scpcli baremetal-blockstorage volume snapshot-rate set
--volume_id <value>
--snapshot_rate <value>

Description

Set Volume snapshot rate.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260331

Parameters

Name	Type	Description	Example
volume_id required	string	Volume id	`92cd16fe8ebc4f73832513a172bf0000`
snapshot_rate required	integer	Snapshot rate	`100`

3.1.36.3 - 1.0

scpcli baremetal-blockstorage volume snapshot-rate set
--volume_id <value>
--snapshot_rate <value>

Description

Set Volume snapshot rate.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
volume_id required	string	Volume id	`92cd16fe8ebc4f73832513a172bf0000`
snapshot_rate required	integer	Snapshot rate	`100`

3.1.37 - Set Volume Snapshot Schedule

3.1.37.1 - 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 (CURRENT)

Version	Supported Until
1.2	-

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.)	-

3.1.37.2 - 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)

Version	Supported Until
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.)	-

3.1.37.3 - 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)

Version	Supported Until
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.)	-

3.1.38 - Show Volume

3.1.38.1 - 1.2

scpcli baremetal-blockstorage volume show
--volume_id <value>

Description

Show Volume.

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Name	Type	Description	Example
volume_id required	string	Volume id	`92cd16fe8ebc4f73832513a172bf0000`

Responses

Name	Description	Example
result	Volume detail

3.1.38.2 - 1.1

scpcli baremetal-blockstorage volume show
--volume_id <value>

Description

Show Volume.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260331

Parameters

Name	Type	Description	Example
volume_id required	string	Volume id	`92cd16fe8ebc4f73832513a172bf0000`

Responses

Name	Description	Example
result	Volume detail

3.1.38.3 - 1.0

scpcli baremetal-blockstorage volume show
--volume_id <value>

Description

Show Volume.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
volume_id required	string	Volume id	`92cd16fe8ebc4f73832513a172bf0000`

Responses

Name	Description	Example
result	Volume detail

3.1.39 - Show Volume Group

3.1.39.1 - 1.2

scpcli baremetal-blockstorage volume-group show
--volume_group_id <value>

Description

Show Volume Group

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Name	Type	Description	Example
volume_group_id required	string	Volume group id	`c9ecae8b973b425c81c3817893cd8063`

Responses

Name	Description	Example
result	Volume group detail

3.1.39.2 - 1.1

scpcli baremetal-blockstorage volume-group show
--volume_group_id <value>

Description

Show Volume Group

State ACTIVE (DEPRECATED)

Version	Supported Until
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

3.1.39.3 - 1.0

scpcli baremetal-blockstorage volume-group show
--volume_group_id <value>

Description

Show Volume Group

State ACTIVE (DEPRECATED)

Version	Supported Until
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

3.1.40 - Show Volume Group Replication

3.1.40.1 - 1.2

scpcli baremetal-blockstorage volume-group replication show
--volume_group_id <value>

Description

Show Volume Group Replication

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Name	Type	Description	Example
volume_group_id required	string	Volume group id	`c9ecae8b973b425c81c3817893cd8063`

Responses

Name	Description	Example
result	Volume group replication detail

3.1.40.2 - 1.1

scpcli baremetal-blockstorage volume-group replication show
--volume_group_id <value>

Description

Show Volume Group Replication

State ACTIVE (DEPRECATED)

Version	Supported Until
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

3.1.40.3 - 1.0

scpcli baremetal-blockstorage volume-group replication show
--volume_group_id <value>

Description

Show Volume Group Replication

State ACTIVE (DEPRECATED)

Version	Supported Until
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

3.1.41 - Show Volume Replication

3.1.41.1 - 1.2

scpcli baremetal-blockstorage volume replication show
--volume_id <value>

Description

Show Volume Replication.

State ACTIVE (CURRENT)

Version	Supported Until
1.2	-

Parameters

Name	Type	Description	Example
volume_id required	string	Volume id	`92cd16fe8ebc4f73832513a172bf0000`

Responses

Name	Description	Example
result	Volume replication detail

3.1.41.2 - 1.1

scpcli baremetal-blockstorage volume replication show
--volume_id <value>

Description

Show Volume Replication.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.1	20260331

Parameters

Name	Type	Description	Example
volume_id required	string	Volume id	`92cd16fe8ebc4f73832513a172bf0000`

Responses

Name	Description	Example
result	Volume replication detail

3.1.41.3 - 1.0

scpcli baremetal-blockstorage volume replication show
--volume_id <value>

Description

Show Volume Replication.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
volume_id required	string	Volume id	`92cd16fe8ebc4f73832513a172bf0000`

Responses

Name	Description	Example
result	Volume replication detail

4 - File Storage

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 File Storage service and how to call CLI.

Version

Version	Status	Supported Until
1.0	DEPRECATED	20251231
1.1	CURRENT	-

4.1 - CLIs

4.1.1 - CreateSnapshot

4.1.1.1 - 1.1

scpcli filestorage volume snapshot create
--volume_id <value>

Description

Create snapshot

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
volume_id required	string	Volume ID	`bfdbabf2-04d9-4e8b-a205-020f8e6da438`

Responses

Name	Description	Example
id	Snapshot ID	40htrre5b-eww25-ff2b-a426-6afefas65a3b
name	Snapshot Name	my_volume.2024-10-01_14215
state	Snapshot State	available
size	Snapshot Size	100
created_at	Created At	2024-07-30T04:54:33.219373
volume_id	Volume ID	bfdbabf2-04d9-4e8b-a205-020f8e6da438

4.1.1.2 - 1.0

scpcli filestorage volume snapshot create
--volume_id <value>

Description

Create snapshot

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
volume_id required	string	Volume ID	`bfdbabf2-04d9-4e8b-a205-020f8e6da438`

Responses

Name	Description	Example
id	Snapshot ID	40htrre5b-eww25-ff2b-a426-6afefas65a3b
name	Snapshot Name	my_volume.2024-10-01_14215
state	Snapshot State	available
size	Snapshot Size	100
created_at	Created At	2024-07-30T04:54:33.219373
volume_id	Volume ID	bfdbabf2-04d9-4e8b-a205-020f8e6da438

4.1.2 - CreateSnapshotSchedule

4.1.2.1 - 1.1

scpcli filestorage volume snapshot schedule create
--hour <value>
--frequency <value>
--volume_id <value>
[--snapshot_retention_count <value>]
[--day_of_week <value>]

Description

Create snapshot schedule

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
hour required	string	Hour of the snapshot schedule	`23`
frequency required	string	Frequency of the snapshot	`WEEKLY`
volume_id required	string	Volume ID	`bfdbabf2-04d9-4e8b-a205-020f8e6da438`
snapshot_retention_count optional	integer	Retention count	`10`
day_of_week optional	string	Day of week of the snapshot schedule	`MON`

Responses

Name	Description	Example
frequency	Frequency of the snapshot	WEEKLY
day_of_week	Day of week of the snapshot schedule	MON
hour	Hour of the snapshot schedule	23

4.1.2.2 - 1.0

scpcli filestorage volume snapshot schedule create
--hour <value>
--frequency <value>
--volume_id <value>
[--snapshot_retention_count <value>]
[--day_of_week <value>]

Description

Create snapshot schedule

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
hour required	string	Hour of the snapshot schedule	`23`
frequency required	string	Frequency of the snapshot	`WEEKLY`
volume_id required	string	Volume ID	`bfdbabf2-04d9-4e8b-a205-020f8e6da438`
snapshot_retention_count optional	integer	Retention count	`10`
day_of_week optional	string	Day of week of the snapshot schedule	`MON`

Responses

Name	Description	Example
frequency	Frequency of the snapshot	WEEKLY
day_of_week	Day of week of the snapshot schedule	MON
hour	Hour of the snapshot schedule	23

4.1.3 - CreateVolume

4.1.3.1 - 1.1

scpcli filestorage volume create
--type_name <value>
--protocol <value>
--name <value>
[--snapshot_id <value>]
[--cifs_password <value>]
[--tags <value>]

Description

Create volume

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
type_name required	string	Volume Type Name	`HDD`
protocol required	string	Protocol	`NFS`
name required	string	Volume Name	`my_volume`
snapshot_id optional	string	Snapshot ID	`40htrre5b-eww25-ff2b-a426-6afefas65a3b`
cifs_password optional	string	CIFS Password	`cifspwd0!!`
tags optional	array		`'{"key": "key", "value": "value"}'`

Responses

Name	Description	Example
protocol	Protocol	NFS
snapshot_id	Snapshot ID	40htrre5b-eww25-ff2b-a426-6afefas65a3b
type_name	Volume Type Name	HDD
volume_id	Volume ID	bfdbabf2-04d9-4e8b-a205-020f8e6da438
volume_name	Volume Name	my_volume

4.1.3.2 - 1.0

scpcli filestorage volume create
--type_name <value>
--protocol <value>
--name <value>
[--snapshot_id <value>]
[--cifs_password <value>]
[--tags <value>]

Description

Create volume

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
type_name required	string	Volume Type Name	`HDD`
protocol required	string	Protocol	`NFS`
name required	string	Volume Name	`my_volume`
snapshot_id optional	string	Snapshot ID	`40htrre5b-eww25-ff2b-a426-6afefas65a3b`
cifs_password optional	string	CIFS Password	`cifspwd0!!`
tags optional	array		`'{"key": "key", "value": "value"}'`

Responses

Name	Description	Example
protocol	Protocol	NFS
snapshot_id	Snapshot ID	40htrre5b-eww25-ff2b-a426-6afefas65a3b
type_name	Volume Type Name	HDD
volume_id	Volume ID	bfdbabf2-04d9-4e8b-a205-020f8e6da438
volume_name	Volume Name	my_volume

4.1.4 - CreateVolumeReplication

4.1.4.1 - 1.1

scpcli filestorage volume replication create
--replication_type <value>
--volume_id <value>
--region <value>
--replication_frequency <value>
--name <value>
[--cifs_password <value>]
[--backup_retention_count <value>]

Description

Create Volume Replication

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
replication_type required	string	Replication Type	`replication`
volume_id required	string	Source Volume ID	`bfdbabf2-04d9-4e8b-a205-020f8e6da438`
region required	string	Target Region	`kr-west1`
replication_frequency required	string	Frequency	`5min`
name required	string	Target Volume Name	`my_volume`
cifs_password optional	string	CIFS Password	`cifspwd0!!`
backup_retention_count optional	integer	Backup Retention Count	`2`

Responses

Name	Description	Example
replication_id	Replication ID	bfdbabf2-04d9-4e8b-a205-020f8e6da438
replication_status	Replication Status	creating
source_volume_id	Source Volume ID	bfdbabf2-04d9-4e8b-a205-020f8e6da438
source_volume_region	Source Region	kr-west1
protocol	Protocol	NFS
replication_volume_id	Target Volume ID	bfdbabf2-04d9-4e8b-a205-020f8e6da438
replication_volume_region	Target Region	kr-west1

4.1.4.2 - 1.0

scpcli filestorage volume replication create
--replication_type <value>
--volume_id <value>
--region <value>
--replication_frequency <value>
--name <value>
[--cifs_password <value>]
[--backup_retention_count <value>]

Description

Create Volume Replication

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
replication_type required	string	Replication Type	`replication`
volume_id required	string	Source Volume ID	`bfdbabf2-04d9-4e8b-a205-020f8e6da438`
region required	string	Target Region	`kr-west1`
replication_frequency required	string	Frequency	`5min`
name required	string	Target Volume Name	`my_volume`
cifs_password optional	string	CIFS Password	`cifspwd0!!`
backup_retention_count optional	integer	Backup Retention Count	`2`

Responses

Name	Description	Example
replication_id	Replication ID	bfdbabf2-04d9-4e8b-a205-020f8e6da438
replication_status	Replication Status	creating
source_volume_id	Source Volume ID	bfdbabf2-04d9-4e8b-a205-020f8e6da438
source_volume_region	Source Region	kr-west1
protocol	Protocol	NFS
replication_volume_id	Target Volume ID	bfdbabf2-04d9-4e8b-a205-020f8e6da438
replication_volume_region	Target Region	kr-west1

4.1.5 - DeleteSnapshot

4.1.5.1 - 1.1

scpcli filestorage volume snapshot delete
--snapshot_id <value>
--volume_id <value>

Description

Delete snapshots

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
snapshot_id required	string	Snapshot ID	`40htrre5b-eww25-ff2b-a426-6afefas65a3b`
volume_id required	string	Volume ID	`bfdbabf2-04d9-4e8b-a205-020f8e6da438`

4.1.5.2 - 1.0

scpcli filestorage volume snapshot delete
--snapshot_id <value>
--volume_id <value>

Description

Delete snapshots

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
snapshot_id required	string	Snapshot ID	`40htrre5b-eww25-ff2b-a426-6afefas65a3b`
volume_id required	string	Volume ID	`bfdbabf2-04d9-4e8b-a205-020f8e6da438`

4.1.6 - DeleteSnapshotSchedule

4.1.6.1 - 1.1

scpcli filestorage volume snapshot schedule delete
--snapshot_schedule_id <value>
--volume_id <value>

Description

Delete snapshot schedule

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
snapshot_schedule_id required	string	Snapshot Schedule ID	`d02d1a74-1871-4a3d-bdfc-6e60e9ea0f31`
volume_id required	string	Volume ID	`bfdbabf2-04d9-4e8b-a205-020f8e6da438`

4.1.6.2 - 1.0

scpcli filestorage volume snapshot schedule delete
--snapshot_schedule_id <value>
--volume_id <value>

Description

Delete snapshot schedule

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
snapshot_schedule_id required	string	Snapshot Schedule ID	`d02d1a74-1871-4a3d-bdfc-6e60e9ea0f31`
volume_id required	string	Volume ID	`bfdbabf2-04d9-4e8b-a205-020f8e6da438`

4.1.7 - DeleteVolume

4.1.7.1 - 1.1

scpcli filestorage volume delete
--volume_id <value>

Description

Delete volume

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
volume_id required	string	Volume ID	`bfdbabf2-04d9-4e8b-a205-020f8e6da438`

4.1.7.2 - 1.0

scpcli filestorage volume delete
--volume_id <value>

Description

Delete volume

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
volume_id required	string	Volume ID	`bfdbabf2-04d9-4e8b-a205-020f8e6da438`

4.1.8 - DeleteVolumeReplication

4.1.8.1 - 1.1

scpcli filestorage volume replication delete
--replication_id <value>
--volume_id <value>

Description

Delete Volume Replication

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
replication_id required	string	Replication ID	`bfdbabf2-04d9-4e8b-a205-020f8e6da438`
volume_id required	string	Volume ID	`bfdbabf2-04d9-4e8b-a205-020f8e6da438`

4.1.8.2 - 1.0

scpcli filestorage volume replication delete
--replication_id <value>
--volume_id <value>

Description

Delete Volume Replication

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
replication_id required	string	Replication ID	`bfdbabf2-04d9-4e8b-a205-020f8e6da438`
volume_id required	string	Volume ID	`bfdbabf2-04d9-4e8b-a205-020f8e6da438`

4.1.9 - ListAccessRules

4.1.9.1 - 1.1

scpcli filestorage volume access rule list
--volume_id <value>

Description

List access rules

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
volume_id required	string	Volume ID	`bfdbabf2-04d9-4e8b-a205-020f8e6da438`

Responses

Name	Description	Example
access_rule_state	Access Rule State	active
object_type	Object Type	VM
object_id	Object ID	43fq3347-02q4-4aa8-ccf9-affe4917bb6f

4.1.9.2 - 1.0

scpcli filestorage volume access rule list
--volume_id <value>

Description

List access rules

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
volume_id required	string	Volume ID	`bfdbabf2-04d9-4e8b-a205-020f8e6da438`

Responses

Name	Description	Example
access_rule_state	Access Rule State	active
object_type	Object Type	VM
object_id	Object ID	43fq3347-02q4-4aa8-ccf9-affe4917bb6f

4.1.10 - ListSnapshots

4.1.10.1 - 1.1

scpcli filestorage volume snapshot list
--volume_id <value>

Description

List snapshots

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
volume_id required	string	Volume ID	`bfdbabf2-04d9-4e8b-a205-020f8e6da438`

Responses

Name	Description	Example
id	Snapshot ID	40htrre5b-eww25-ff2b-a426-6afefas65a3b
name	Snapshot Name	my_volume.2024-10-01_14215
state	Snapshot State	available
size	Snapshot Size	100
created_at	Created At	2024-07-30T04:54:33.219373

4.1.10.2 - 1.0

scpcli filestorage volume snapshot list
--volume_id <value>

Description

List snapshots

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
volume_id required	string	Volume ID	`bfdbabf2-04d9-4e8b-a205-020f8e6da438`

Responses

Name	Description	Example
id	Snapshot ID	40htrre5b-eww25-ff2b-a426-6afefas65a3b
name	Snapshot Name	my_volume.2024-10-01_14215
state	Snapshot State	available
size	Snapshot Size	100
created_at	Created At	2024-07-30T04:54:33.219373

4.1.11 - ListSnapshotSchedule

4.1.11.1 - 1.1

scpcli filestorage volume snapshot schedule list
--volume_id <value>

Description

List snapshot schedule

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
volume_id required	string	Volume ID	`bfdbabf2-04d9-4e8b-a205-020f8e6da438`

Responses

Name	Description	Example
id	Snapshot Schedule ID	d02d1a74-1871-4a3d-bdfc-6e60e9ea0f31
frequency	Frequency of the snapshot	WEEKLY
day_of_week	Day of week of the snapshot schedule	MON
hour	Hour of the snapshot schedule	23

4.1.11.2 - 1.0

scpcli filestorage volume snapshot schedule list
--volume_id <value>

Description

List snapshot schedule

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
volume_id required	string	Volume ID	`bfdbabf2-04d9-4e8b-a205-020f8e6da438`

Responses

Name	Description	Example
id	Snapshot Schedule ID	d02d1a74-1871-4a3d-bdfc-6e60e9ea0f31
frequency	Frequency of the snapshot	WEEKLY
day_of_week	Day of week of the snapshot schedule	MON
hour	Hour of the snapshot schedule	23

4.1.12 - ListVolumeReplicationRegion

4.1.12.1 - 1.1

scpcli filestorage volume replication region list
--replication_type <value>
--source_region_name <value>
[--type_name <value>]

Description

List Volume Replication Region

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
replication_type required	string	Replication Type	`replication`
source_region_name required	string	Region	`kr-west1`
type_name optional	string	Volume Type Name	`HDD`

Responses

Name	Description	Example
regions	Replication Region List	[‘kr-west1’]

4.1.12.2 - 1.0

scpcli filestorage volume replication region list
--replication_type <value>
--source_region_name <value>
[--type_name <value>]

Description

List Volume Replication Region

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
replication_type required	string	Replication Type	`replication`
source_region_name required	string	Region	`kr-west1`
type_name optional	string	Volume Type Name	`HDD`

Responses

Name	Description	Example
regions	Replication Region List	[‘kr-west1’]

4.1.13 - ListVolumeReplications

4.1.13.1 - 1.1

scpcli filestorage volume replication list
--volume_id <value>

Description

List Volume Replications

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
volume_id required	string	Volume ID	`bfdbabf2-04d9-4e8b-a205-020f8e6da438`

Responses

Name	Description	Example
replication_id	Replication ID	bfdbabf2-04d9-4e8b-a205-020f8e6da438
replication_frequency	Frequency	5min
source_volume_id	Source Volume ID	bfdbabf2-04d9-4e8b-a205-020f8e6da438
source_volume_region	Source Region	kr-west1
source_volume_access_level	Source Access Level	ro
replication_volume_id	Target Volume ID	bfdbabf2-04d9-4e8b-a205-020f8e6da438
replication_volume_region	Target Region	kr-west1
replication_volume_access_level	Target Access Level	ro
replication_type	Replication Type	replication

4.1.13.2 - 1.0

scpcli filestorage volume replication list
--volume_id <value>

Description

List Volume Replications

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
volume_id required	string	Volume ID	`bfdbabf2-04d9-4e8b-a205-020f8e6da438`

Responses

Name	Description	Example
replication_id	Replication ID	bfdbabf2-04d9-4e8b-a205-020f8e6da438
replication_frequency	Frequency	5min
source_volume_id	Source Volume ID	bfdbabf2-04d9-4e8b-a205-020f8e6da438
source_volume_region	Source Region	kr-west1
source_volume_access_level	Source Access Level	ro
replication_volume_id	Target Volume ID	bfdbabf2-04d9-4e8b-a205-020f8e6da438
replication_volume_region	Target Region	kr-west1
replication_volume_access_level	Target Access Level	ro
replication_type	Replication Type	replication

4.1.14 - ListVolumes

4.1.14.1 - 1.1

scpcli filestorage volume list
[--offset <value>]
[--limit <value>]
[--name <value>]
[--type_name <value>]
[--sort <value>]

Description

List volumes

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
offset optional	integer	offset	-
limit optional	integer	limit	-
name optional	string	Volume Name	`my_volume`
type_name optional	string	Volume Type Name	`HDD`
sort optional	string	sort	-

Responses

Name	Description	Example
id	Volume ID	bfdbabf2-04d9-4e8b-a205-020f8e6da438
name	Volume Name	my_volume
protocol	Protocol	NFS
state	Volume State	available
account_id	Account ID	rwww523320dfvwbbefefsdvwdadsfa24c
created_at	Created At	2024-07-30T04:54:33.219373
type_id	Volume Type ID	jef22f67-ee83-4gg2-2ab6-3lf774ekfjdu
type_name	Volume Type Name	HDD
purpose	Purpose	replication

4.1.14.2 - 1.0

scpcli filestorage volume list
[--offset <value>]
[--limit <value>]
[--name <value>]
[--type_name <value>]
[--sort <value>]

Description

List volumes

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
offset optional	integer	offset	-
limit optional	integer	limit	-
name optional	string	Volume Name	`my_volume`
type_name optional	string	Volume Type Name	`HDD`
sort optional	string	sort	-

Responses

Name	Description	Example
id	Volume ID	bfdbabf2-04d9-4e8b-a205-020f8e6da438
name	Volume Name	my_volume
protocol	Protocol	NFS
state	Volume State	available
account_id	Account ID	rwww523320dfvwbbefefsdvwdadsfa24c
created_at	Created At	2024-07-30T04:54:33.219373
type_id	Volume Type ID	jef22f67-ee83-4gg2-2ab6-3lf774ekfjdu
type_name	Volume Type Name	HDD
purpose	Purpose	replication

4.1.15 - RestoreSnapshot

4.1.15.1 - 1.1

scpcli filestorage volume snapshot set
--snapshot_id <value>
--volume_id <value>

Description

Restore snapshot

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
snapshot_id required	string	Snapshot ID	`40htrre5b-eww25-ff2b-a426-6afefas65a3b`
volume_id required	string	Volume ID	`bfdbabf2-04d9-4e8b-a205-020f8e6da438`

4.1.15.2 - 1.0

scpcli filestorage volume snapshot set
--snapshot_id <value>
--volume_id <value>

Description

Restore snapshot

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
snapshot_id required	string	Snapshot ID	`40htrre5b-eww25-ff2b-a426-6afefas65a3b`
volume_id required	string	Volume ID	`bfdbabf2-04d9-4e8b-a205-020f8e6da438`

4.1.16 - SetAccessRule

4.1.16.1 - 1.1

scpcli filestorage volume access rule set
--volume_id <value>
--action <value>
--object_type <value>
--object_id <value>

Description

Set access rule for volume

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
volume_id required	string	Volume ID	`bfdbabf2-04d9-4e8b-a205-020f8e6da438`
action required	string	Access Rule Action	`add`
object_type required	string	Object Type	`VM`
object_id required	string	Object ID	`43fq3347-02q4-4aa8-ccf9-affe4917bb6f`

4.1.16.2 - 1.0

scpcli filestorage volume access rule set
--volume_id <value>
--action <value>
--object_type <value>
--object_id <value>

Description

Set access rule for volume

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
volume_id required	string	Volume ID	`bfdbabf2-04d9-4e8b-a205-020f8e6da438`
action required	string	Access Rule Action	`add`
object_type required	string	Object Type	`VM`
object_id required	string	Object ID	`43fq3347-02q4-4aa8-ccf9-affe4917bb6f`

4.1.17 - SetSnapshotSchedule

4.1.17.1 - 1.1

scpcli filestorage volume snapshot schedule set
--snapshot_schedule_id <value>
--volume_id <value>
--hour <value>
--frequency <value>
[--snapshot_retention_count <value>]
[--day_of_week <value>]

Description

Set snapshot schedule

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
snapshot_schedule_id required	string	Snapshot Schedule ID	`d02d1a74-1871-4a3d-bdfc-6e60e9ea0f31`
volume_id required	string	Volume ID	`bfdbabf2-04d9-4e8b-a205-020f8e6da438`
hour required	string	Hour of the snapshot schedule	`23`
frequency required	string	Frequency of the snapshot	`WEEKLY`
snapshot_retention_count optional	integer	Retention count	`10`
day_of_week optional	string	Day of week of the snapshot schedule	`MON`

4.1.17.2 - 1.0

scpcli filestorage volume snapshot schedule set
--snapshot_schedule_id <value>
--volume_id <value>
--hour <value>
--frequency <value>
[--snapshot_retention_count <value>]
[--day_of_week <value>]

Description

Set snapshot schedule

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
snapshot_schedule_id required	string	Snapshot Schedule ID	`d02d1a74-1871-4a3d-bdfc-6e60e9ea0f31`
volume_id required	string	Volume ID	`bfdbabf2-04d9-4e8b-a205-020f8e6da438`
hour required	string	Hour of the snapshot schedule	`23`
frequency required	string	Frequency of the snapshot	`WEEKLY`
snapshot_retention_count optional	integer	Retention count	`10`
day_of_week optional	string	Day of week of the snapshot schedule	`MON`

4.1.18 - SetVolume

4.1.18.1 - 1.1

scpcli filestorage volume set
--volume_id <value>
--file_unit_recovery_enabled <value>

Description

Set volume

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
volume_id required	string	Volume ID	`bfdbabf2-04d9-4e8b-a205-020f8e6da438`
file_unit_recovery_enabled required	boolean	Volume File Unit Recovery Enabled	`True`

4.1.18.2 - 1.0

scpcli filestorage volume set
--volume_id <value>
--file_unit_recovery_enabled <value>

Description

Set volume

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
volume_id required	string	Volume ID	`bfdbabf2-04d9-4e8b-a205-020f8e6da438`
file_unit_recovery_enabled required	boolean	Volume File Unit Recovery Enabled	`True`

4.1.19 - SetVolumeReplication

4.1.19.1 - 1.1

scpcli filestorage volume replication set
--replication_id <value>
--volume_id <value>
--replication_update_type <value>
[--replication_policy <value>]
[--replication_frequency <value>]
[--backup_retention_count <value>]

Description

Set Volume Replication

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
replication_id required	string	Replication ID	`bfdbabf2-04d9-4e8b-a205-020f8e6da438`
volume_id required	string	Volume ID	`bfdbabf2-04d9-4e8b-a205-020f8e6da438`
replication_update_type required	string	Replication Update Type	`policy`
replication_policy optional	****	Policy	`use`
replication_frequency optional	****	Frequency	`5min`
backup_retention_count optional	integer	Backup Retention Count	`2`

4.1.19.2 - 1.0

scpcli filestorage volume replication set
--replication_id <value>
--volume_id <value>
--replication_update_type <value>
[--replication_policy <value>]
[--replication_frequency <value>]
[--backup_retention_count <value>]

Description

Set Volume Replication

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
replication_id required	string	Replication ID	`bfdbabf2-04d9-4e8b-a205-020f8e6da438`
volume_id required	string	Volume ID	`bfdbabf2-04d9-4e8b-a205-020f8e6da438`
replication_update_type required	string	Replication Update Type	`policy`
replication_policy optional	****	Policy	`use`
replication_frequency optional	****	Frequency	`5min`
backup_retention_count optional	integer	Backup Retention Count	`2`

4.1.20 - ShowVolume

4.1.20.1 - 1.1

scpcli filestorage volume show
--volume_id <value>

Description

Show volume

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
volume_id required	string	Volume ID	`bfdbabf2-04d9-4e8b-a205-020f8e6da438`

Responses

Name	Description	Example
id	Volume ID	bfdbabf2-04d9-4e8b-a205-020f8e6da438
name	Volume Name	my_volume
protocol	Protocol	NFS
state	Volume State	available
account_id	Account ID	rwww523320dfvwbbefefsdvwdadsfa24c
created_at	Created At	2024-07-30T04:54:33.219373
type_id	Volume Type ID	jef22f67-ee83-4gg2-2ab6-3lf774ekfjdu
type_name	Volume Type Name	HDD
purpose	Purpose	replication
path	Volume Mount Path	xxx.xx.xxx:/xxxxxxxx
usage	Volume Usage	100000
encryption_enabled	Volume Encryption Enabled	True
file_unit_recovery_enabled	Volume File Unit Recovery Enabled	True
cifs_id	CIFS ID	cifsid
endpoint_path	Volume Endpoint Path	xxx.xx.xxx.xxx

4.1.20.2 - 1.0

scpcli filestorage volume show
--volume_id <value>

Description

Show volume

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
volume_id required	string	Volume ID	`bfdbabf2-04d9-4e8b-a205-020f8e6da438`

Responses

Name	Description	Example
id	Volume ID	bfdbabf2-04d9-4e8b-a205-020f8e6da438
name	Volume Name	my_volume
protocol	Protocol	NFS
state	Volume State	available
account_id	Account ID	rwww523320dfvwbbefefsdvwdadsfa24c
created_at	Created At	2024-07-30T04:54:33.219373
type_id	Volume Type ID	jef22f67-ee83-4gg2-2ab6-3lf774ekfjdu
type_name	Volume Type Name	HDD
purpose	Purpose	replication
path	Volume Mount Path	xxx.xx.xxx:/xxxxxxxx
usage	Volume Usage	100000
encryption_enabled	Volume Encryption Enabled	True
file_unit_recovery_enabled	Volume File Unit Recovery Enabled	True
cifs_id	CIFS ID	cifsid
endpoint_path	Volume Endpoint Path	xxx.xx.xxx.xxx

4.1.21 - ShowVolumeReplication

4.1.21.1 - 1.1

scpcli filestorage volume replication show
--replication_id <value>
--volume_id <value>

Description

Show Volume Replication

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
replication_id required	string	Replication ID	`bfdbabf2-04d9-4e8b-a205-020f8e6da438`
volume_id required	string	Volume ID	`bfdbabf2-04d9-4e8b-a205-020f8e6da438`

Responses

Name	Description	Example
replication_id	Replication ID	bfdbabf2-04d9-4e8b-a205-020f8e6da438
replication_frequency	Frequency	5min
source_volume_id	Source Volume ID	bfdbabf2-04d9-4e8b-a205-020f8e6da438
source_volume_region	Source Region	kr-west1
source_volume_access_level	Source Access Level	ro
replication_volume_id	Target Volume ID	bfdbabf2-04d9-4e8b-a205-020f8e6da438
replication_volume_region	Target Region	kr-west1
replication_volume_access_level	Target Access Level	ro
replication_type	Replication Type	replication
source_volume_name	Source Volume Name	my_volume
replication_policy	Policy	use
replication_status	Replication Status	creating
replication_volume_name	Target Volume Name	my_volume
backup_retention_count	Backup Retention Count	2

4.1.21.2 - 1.0

scpcli filestorage volume replication show
--replication_id <value>
--volume_id <value>

Description

Show Volume Replication

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
replication_id required	string	Replication ID	`bfdbabf2-04d9-4e8b-a205-020f8e6da438`
volume_id required	string	Volume ID	`bfdbabf2-04d9-4e8b-a205-020f8e6da438`

Responses

Name	Description	Example
replication_id	Replication ID	bfdbabf2-04d9-4e8b-a205-020f8e6da438
replication_frequency	Frequency	5min
source_volume_id	Source Volume ID	bfdbabf2-04d9-4e8b-a205-020f8e6da438
source_volume_region	Source Region	kr-west1
source_volume_access_level	Source Access Level	ro
replication_volume_id	Target Volume ID	bfdbabf2-04d9-4e8b-a205-020f8e6da438
replication_volume_region	Target Region	kr-west1
replication_volume_access_level	Target Access Level	ro
replication_type	Replication Type	replication
source_volume_name	Source Volume Name	my_volume
replication_policy	Policy	use
replication_status	Replication Status	creating
replication_volume_name	Target Volume Name	my_volume
backup_retention_count	Backup Retention Count	2

5 - Parallel File Storage

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 Parallel File Storage service and how to call CLI.

Version

Version	Status	Supported Until
1.0	CURRENT	-

5.1 - CLIs

5.1.1 - CreateSnapshot

5.1.1.1 - 1.0

scpcli parallel-filestorage snapshot create
--volume_id <value>

Description

Create snapshot

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

Parameters

Name	Type	Description	Example
volume_id required	string	Volume ID	`bfdbabf2-04d9-4e8b-a205-020f8e6da438`

Responses

Name	Description	Example
snapshot	Snapshot

5.1.2 - CreateVolume

5.1.2.1 - 1.0

scpcli parallel-filestorage volume create
--capacity_tb <value>
--name <value>
[--tags <value>]

Description

Create volume

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

Parameters

Name	Type	Description	Example
capacity_tb required	integer	Volume Capacity	`100`
name required	string	Volume Name	`my_volume`
tags optional	array		`'{"key": "key", "value": "value"}'`

Responses

Name	Description	Example
id	Volume ID	bfdbabf2-04d9-4e8b-a205-020f8e6da438
name	Volume Name	my_volume
state	Volume State	available
created_at	Created At	2024-07-30T04:54:33.219373
capacity_tb	Volume Capacity	100
account_id	Account ID	rwww523320dfvwbbefefsdvwdadsfa24c

5.1.3 - DeleteSnapshot

5.1.3.1 - 1.0

scpcli parallel-filestorage snapshot delete
--snapshot_id <value>
--volume_id <value>

Description

Delete snapshot

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

Parameters

Name	Type	Description	Example
snapshot_id required	string	Snapshot ID	`40htrre5b-eww25-ff2b-a426-6afefas65a3b`
volume_id required	string	Volume ID	`bfdbabf2-04d9-4e8b-a205-020f8e6da438`

5.1.4 - DeleteVolume

5.1.4.1 - 1.0

scpcli parallel-filestorage volume delete
--volume_id <value>

Description

Delete volume

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

Parameters

Name	Type	Description	Example
volume_id required	string	Volume ID	`bfdbabf2-04d9-4e8b-a205-020f8e6da438`

5.1.5 - ListAccessRule

5.1.5.1 - 1.0

scpcli parallel-filestorage access rule list
--volume_id <value>

Description

List access rule

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

Parameters

Name	Type	Description	Example
volume_id required	string	Volume ID	`bfdbabf2-04d9-4e8b-a205-020f8e6da438`

Responses

Name	Description	Example
object_id	Object ID	43fq3347-02q4-4aa8-ccf9-affe4917bb6f
object_type	Object Type	GPU_NODE
object_name	Object Name	objectname
object_state	Object State	RUNNING
access_state	Access State	all
access_ip_list

5.1.6 - ListSnapshots

5.1.6.1 - 1.0

scpcli parallel-filestorage snapshot list
--volume_id <value>

Description

List snapshots

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

Parameters

Name	Type	Description	Example
volume_id required	string	Volume ID	`bfdbabf2-04d9-4e8b-a205-020f8e6da438`

Responses

Name	Description	Example
id	Snapshot ID	40htrre5b-eww25-ff2b-a426-6afefas65a3b
name	Snapshot Name	snapshot.2025-10-30_121212
size	Snapshot Size	100
state	Snapshot State	available
created_at	Created At	2024-10-30T04:54:33.219373

5.1.7 - ListVolumes

5.1.7.1 - 1.0

scpcli parallel-filestorage volume list
[--offset <value>]
[--limit <value>]
[--name <value>]
[--sort <value>]

Description

List volumes

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

Parameters

Name	Type	Description	Example
offset optional	integer	offset	-
limit optional	integer	limit	-
name optional	string	Volume Name	`my_volume`
sort optional	string	sort	-

Responses

Name	Description	Example
id	Volume ID	bfdbabf2-04d9-4e8b-a205-020f8e6da438
name	Volume Name	my_volume
state	Volume State	available
created_at	Created At	2024-07-30T04:54:33.219373
capacity_tb	Volume Capacity	100
account_id	Account ID	rwww523320dfvwbbefefsdvwdadsfa24c

5.1.8 - SetAccessRule

5.1.8.1 - 1.0

scpcli parallel-filestorage access rule set
--volume_id <value>
--remove_access_rules <value>
--add_access_rules <value>

Description

Set access rule

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

Parameters

Name	Type	Description	Example
volume_id required	string	Volume ID	`bfdbabf2-04d9-4e8b-a205-020f8e6da438`
remove_access_rules required	array		`'{"object_id": "43fq3347-02q4-4aa8-ccf9-affe4917bb6f", "object_type": "GPU_NODE"}'`
add_access_rules required	array		`'{"object_id": "43fq3347-02q4-4aa8-ccf9-affe4917bb6f", "object_type": "GPU_NODE"}'`

5.1.9 - SetVolumeCapacity

5.1.9.1 - 1.0

scpcli parallel-filestorage volume capacity set
--volume_id <value>
--capacity_tb <value>

Description

Set volume capacity

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

Parameters

Name	Type	Description	Example
volume_id required	string	Volume ID	`bfdbabf2-04d9-4e8b-a205-020f8e6da438`
capacity_tb required	integer	Volume Capacity	`100`

5.1.10 - ShowVolume

5.1.10.1 - 1.0

scpcli parallel-filestorage volume show
--volume_id <value>

Description

Show volume

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

Parameters

Name	Type	Description	Example
volume_id required	string	Volume ID	`bfdbabf2-04d9-4e8b-a205-020f8e6da438`

Responses

Name	Description	Example
id	Volume ID	bfdbabf2-04d9-4e8b-a205-020f8e6da438
name	Volume Name	my_volume
state	Volume State	available
created_at	Created At	2024-07-30T04:54:33.219373
capacity_tb	Volume Capacity	100
account_id	Account ID	rwww523320dfvwbbefefsdvwdadsfa24c
mount_path	Volume Mount Path	xxx.xx.xxx:/xxxxxxxx