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

Return to the regular view of this page.

Parallel File Storage

1: CLIs

1.1: CreateSnapshot

1.1.1: 1.0

1.2: CreateVolume

1.2.1: 1.0

1.3: DeleteSnapshot

1.3.1: 1.0

1.4: DeleteVolume

1.4.1: 1.0

1.5: ListAccessRule

1.5.1: 1.0

1.6: ListSnapshots

1.6.1: 1.0

1.7: ListVolumes

1.7.1: 1.0

1.8: RestoreSnapshot

1.8.1: 1.0

1.9: SetAccessRule

1.9.1: 1.0

1.10: SetVolumeCapacity

1.10.1: 1.0

1.11: ShowVolume

1.11.1: 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 Parallel 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.0	CURRENT	-

1 - CLIs

1.1 - CreateSnapshot

1.1.1 - 1.0

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

Description

Create snapshot

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

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

Responses

Name	Description	Example
snapshot	Snapshot

1.2 - CreateVolume

1.2.1 - 1.0

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

Description

Create volume

State ACTIVE (CURRENT)

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

1.3 - DeleteSnapshot

1.3.1 - 1.0

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

Description

Delete snapshot

State ACTIVE (CURRENT)

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

1.4 - DeleteVolume

1.4.1 - 1.0

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

Description

Delete volume

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

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

1.5 - ListAccessRule

1.5.1 - 1.0

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

Description

List access rule

State ACTIVE (CURRENT)

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

1.6 - ListSnapshots

1.6.1 - 1.0

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

Description

List snapshots

State ACTIVE (CURRENT)

Version	Not Before
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
state	Snapshot State	available
created_at	Created At	2024-10-30T04:54:33.219373

1.7 - ListVolumes

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

1.8 - RestoreSnapshot

1.8.1 - 1.0

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

Description

Restore snapshot

State ACTIVE (CURRENT)

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

1.9 - SetAccessRule

1.9.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	Not Before
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"}'`

1.10 - SetVolumeCapacity

1.10.1 - 1.0

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

Description

Set volume capacity

State ACTIVE (CURRENT)

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

1.11 - ShowVolume

1.11.1 - 1.0

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

Description

Show volume

State ACTIVE (CURRENT)

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