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

Return to the regular view of this page.

File Storage

1: CLIs

1.1: CreateSnapshot

1.1.1: 1.1
1.1.2: 1.0

1.2: CreateSnapshotSchedule

1.2.1: 1.1
1.2.2: 1.0

1.3: CreateVolume

1.3.1: 1.1
1.3.2: 1.0

1.4: CreateVolumeReplication

1.4.1: 1.1
1.4.2: 1.0

1.5: DeleteSnapshot

1.5.1: 1.1
1.5.2: 1.0

1.6: DeleteSnapshotSchedule

1.6.1: 1.1
1.6.2: 1.0

1.7: DeleteVolume

1.7.1: 1.1
1.7.2: 1.0

1.8: DeleteVolumeReplication

1.8.1: 1.1
1.8.2: 1.0

1.9: ListAccessRules

1.9.1: 1.1
1.9.2: 1.0

1.10: ListSnapshots

1.10.1: 1.1
1.10.2: 1.0

1.11: ListSnapshotSchedule

1.11.1: 1.1
1.11.2: 1.0

1.12: ListVolumeReplicationRegion

1.12.1: 1.1
1.12.2: 1.0

1.13: ListVolumeReplications

1.13.1: 1.1
1.13.2: 1.0

1.14: ListVolumes

1.14.1: 1.1
1.14.2: 1.0

1.15: RestoreSnapshot

1.15.1: 1.1
1.15.2: 1.0

1.16: SetAccessRule

1.16.1: 1.1
1.16.2: 1.0

1.17: SetSnapshotSchedule

1.17.1: 1.1
1.17.2: 1.0

1.18: SetVolume

1.18.1: 1.1
1.18.2: 1.0

1.19: SetVolumeReplication

1.19.1: 1.1
1.19.2: 1.0

1.20: ShowVolume

1.20.1: 1.1
1.20.2: 1.0

1.21: ShowVolumeReplication

1.21.1: 1.1
1.21.2: 1.0

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

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Status	Not Before
1.1	CURRENT	-
1.0	DEPRECATED	20251231

1 - CLIs

1.1 - CreateSnapshot

1.1.1 - 1.1

scpcli filestorage volume snapshot create
--volume_id <value>

Description

Create snapshot

State ACTIVE (CURRENT)

Version	Not Before
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
created_at	Created At	2024-07-30T04:54:33.219373
volume_id	Volume ID	bfdbabf2-04d9-4e8b-a205-020f8e6da438

1.1.2 - 1.0

scpcli filestorage volume snapshot create
--volume_id <value>

Description

Create snapshot

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
volume_id required	string	Volume ID	`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
created_at	Created At	2024-07-30T04:54:33.219373
volume_id	Volume ID	bfdbabf2-04d9-4e8b-a205-020f8e6da438

1.2 - CreateSnapshotSchedule

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	Not Before
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

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)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
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

1.3 - CreateVolume

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	Not Before
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

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)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
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

1.4 - CreateVolumeReplication

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	Not Before
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

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)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
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

1.5 - DeleteSnapshot

1.5.1 - 1.1

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

Description

Delete snapshots

State ACTIVE (CURRENT)

Version	Not Before
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`

1.5.2 - 1.0

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

Description

Delete snapshots

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

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

1.6 - DeleteSnapshotSchedule

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	Not Before
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`

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)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

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

1.7 - DeleteVolume

1.7.1 - 1.1

scpcli filestorage volume delete
--volume_id <value>

Description

Delete volume

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

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

1.7.2 - 1.0

scpcli filestorage volume delete
--volume_id <value>

Description

Delete volume

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

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

1.8 - DeleteVolumeReplication

1.8.1 - 1.1

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

Description

Delete Volume Replication

State ACTIVE (CURRENT)

Version	Not Before
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`

1.8.2 - 1.0

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

Description

Delete Volume Replication

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

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

1.9 - ListAccessRules

1.9.1 - 1.1

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

Description

List access rules

State ACTIVE (CURRENT)

Version	Not Before
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

1.9.2 - 1.0

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

Description

List access rules

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
volume_id required	string	Volume ID	`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

1.10 - ListSnapshots

1.10.1 - 1.1

scpcli filestorage volume snapshot list
--volume_id <value>

Description

List snapshots

State ACTIVE (CURRENT)

Version	Not Before
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
created_at	Created At	2024-07-30T04:54:33.219373

1.10.2 - 1.0

scpcli filestorage volume snapshot list
--volume_id <value>

Description

List snapshots

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
volume_id required	string	Volume ID	`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
created_at	Created At	2024-07-30T04:54:33.219373

1.11 - ListSnapshotSchedule

1.11.1 - 1.1

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

Description

List snapshot schedule

State ACTIVE (CURRENT)

Version	Not Before
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

1.11.2 - 1.0

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

Description

List snapshot schedule

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
volume_id required	string	Volume ID	`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

1.12 - ListVolumeReplicationRegion

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	Not Before
1.1	-

Parameters

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

Responses

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

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)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

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

Responses

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

1.13 - ListVolumeReplications

1.13.1 - 1.1

scpcli filestorage volume replication list
--volume_id <value>

Description

List Volume Replications

State ACTIVE (CURRENT)

Version	Not Before
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

1.13.2 - 1.0

scpcli filestorage volume replication list
--volume_id <value>

Description

List Volume Replications

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
volume_id required	string	Volume ID	`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

1.14 - ListVolumes

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	Not Before
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

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)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
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

1.15 - RestoreSnapshot

1.15.1 - 1.1

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

Description

Restore snapshot

State ACTIVE (CURRENT)

Version	Not Before
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`

1.15.2 - 1.0

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

Description

Restore snapshot

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

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

1.16 - SetAccessRule

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	Not Before
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`

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)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
volume_id required	string	Volume ID	`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`

1.17 - SetSnapshotSchedule

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	Not Before
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`

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)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
snapshot_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`

1.18 - SetVolume

1.18.1 - 1.1

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

Description

Set volume

State ACTIVE (CURRENT)

Version	Not Before
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`

1.18.2 - 1.0

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

Description

Set volume

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

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

1.19 - SetVolumeReplication

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	Not Before
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`

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)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
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`

1.20 - ShowVolume

1.20.1 - 1.1

scpcli filestorage volume show
--volume_id <value>

Description

Show volume

State ACTIVE (CURRENT)

Version	Not Before
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
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

1.20.2 - 1.0

scpcli filestorage volume show
--volume_id <value>

Description

Show volume

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
volume_id required	string	Volume ID	`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
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

1.21 - ShowVolumeReplication

1.21.1 - 1.1

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

Description

Show Volume Replication

State ACTIVE (CURRENT)

Version	Not Before
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

1.21.2 - 1.0

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

Description

Show Volume Replication

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
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