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

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.

VersionStatusNot Before
1.1CURRENT-
1.0SUPPORTED20261130

CLI Version History

1.1

Parallel File Storage CLI has been updated to version 1.1.

Changes

  • [Updated] parallel-filestorage volume create - The following argument has been added.
    • NEW --zone - Required argument added. Zone of the volume.
  • [Updated] parallel-filestorage volume list - The following output columns have been added.
    • NEW zone - Zone of the volume.
  • [Updated] parallel-filestorage volume list - The --sort option now accepts additional sort values.
    • NEW protocol:asc, protocol:desc, zone:asc, zone:desc sort options have been added.
  • [Updated] parallel-filestorage volume show - The following output field has been added.
    • NEW zone - Zone of the volume.
  • [New] parallel-filestorage volume snapshot restore - Restore snapshot command has been added.
  • [Updated] parallel-filestorage volume snapshot list - The following output fields have been changed.
    • NEW snapshot_size_total_byte - Optional field added to the top-level response.
    • UPDATED size - Changed from required to optional field.
  • [Updated] parallel-filestorage volume access rule list - The command now requires volume_id as a positional argument instead of --volume_id query parameter.
  • [Updated] parallel-filestorage volume access rule set - The command now requires volume_id as a positional argument instead of --volume_id query parameter.

1.0

Parallel File Storage CLI has been released.

Changes

  • [New] parallel-filestorage volume list - List volumes command has been added.
  • [New] parallel-filestorage volume create - Create volume command has been added.
  • [New] parallel-filestorage volume show - Show volume command has been added.
  • [New] parallel-filestorage volume delete - Delete volume command has been added.
  • [New] parallel-filestorage volume capacity set - Set volume capacity command has been added.
  • [New] parallel-filestorage volume access rule list - List access rules command has been added.
  • [New] parallel-filestorage volume access rule set - Set access rule for volume command has been added.
  • [New] parallel-filestorage volume snapshot list - List snapshots command has been added.
  • [New] parallel-filestorage volume snapshot create - Create snapshot command has been added.
  • [New] parallel-filestorage volume snapshot delete - Delete snapshot command has been added.

1 - CLIs

1.1 - CreateSnapshot

1.1.1 - 1.1

scp-cli parallel-filestorage snapshot create
--volume_id <value>

Description

Create snapshot

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
volume_id
required		stringVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438

Responses

NameDescriptionExample
snapshotSnapshot

1.1.2 - 1.0

scp-cli parallel-filestorage snapshot create
--volume_id <value>

Description

Create snapshot

State ACTIVE (SUPPORTED)

VersionNot Before
1.020261130

Parameters

NameTypeDescriptionExample
volume_id
required		stringVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438

Responses

NameDescriptionExample
snapshotSnapshot

1.2 - CreateVolume

1.2.1 - 1.1

scp-cli parallel-filestorage volume create
--zone <value>
--capacity_tb <value>
--name <value>
[--tags <value>]

Description

Create volume

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
zone
required		stringZonekr-west1-a
capacity_tb
required		integerVolume Capacity100
name
required		stringVolume Namemy_volume
tags
optional		array'{"key": "key", "value": "value"}'

Responses

NameDescriptionExample
idVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
nameVolume Namemy_volume
stateVolume Stateavailable
created_atCreated At2024-07-30T04:54:33.219373
capacity_tbVolume Capacity100
account_idAccount IDrwww523320dfvwbbefefsdvwdadsfa24c
zoneZonekr-west1-a

1.2.2 - 1.0

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

Description

Create volume

State ACTIVE (SUPPORTED)

VersionNot Before
1.020261130

Parameters

NameTypeDescriptionExample
capacity_tb
required		integerVolume Capacity100
name
required		stringVolume Namemy_volume
tags
optional		array'{"key": "key", "value": "value"}'

Responses

NameDescriptionExample
idVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
nameVolume Namemy_volume
stateVolume Stateavailable
created_atCreated At2024-07-30T04:54:33.219373
capacity_tbVolume Capacity100
account_idAccount IDrwww523320dfvwbbefefsdvwdadsfa24c

1.3 - DeleteSnapshot

1.3.1 - 1.1

scp-cli parallel-filestorage snapshot delete
--snapshot_id <value>
--volume_id <value>

Description

Delete snapshot

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
snapshot_id
required		stringSnapshot ID40htrre5b-eww25-ff2b-a426-6afefas65a3b
volume_id
required		stringVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438

1.3.2 - 1.0

scp-cli parallel-filestorage snapshot delete
--snapshot_id <value>
--volume_id <value>

Description

Delete snapshot

State ACTIVE (SUPPORTED)

VersionNot Before
1.020261130

Parameters

NameTypeDescriptionExample
snapshot_id
required		stringSnapshot ID40htrre5b-eww25-ff2b-a426-6afefas65a3b
volume_id
required		stringVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438

1.4 - DeleteVolume

1.4.1 - 1.1

scp-cli parallel-filestorage volume delete
--volume_id <value>

Description

Delete volume

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
volume_id
required		stringVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438

1.4.2 - 1.0

scp-cli parallel-filestorage volume delete
--volume_id <value>

Description

Delete volume

State ACTIVE (SUPPORTED)

VersionNot Before
1.020261130

Parameters

NameTypeDescriptionExample
volume_id
required		stringVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438

1.5 - ListAccessRule

1.5.1 - 1.1

scp-cli parallel-filestorage access rule list
--volume_id <value>

Description

List access rule

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
volume_id
required		stringVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438

Responses

NameDescriptionExample
object_idObject ID43fq3347-02q4-4aa8-ccf9-affe4917bb6f
object_typeObject TypeGPU_NODE
object_nameObject Nameobjectname
object_stateObject StateRUNNING
access_stateAccess Stateall
access_ip_list

1.5.2 - 1.0

scp-cli parallel-filestorage access rule list
--volume_id <value>

Description

List access rule

State ACTIVE (SUPPORTED)

VersionNot Before
1.020261130

Parameters

NameTypeDescriptionExample
volume_id
required		stringVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438

Responses

NameDescriptionExample
object_idObject ID43fq3347-02q4-4aa8-ccf9-affe4917bb6f
object_typeObject TypeGPU_NODE
object_nameObject Nameobjectname
object_stateObject StateRUNNING
access_stateAccess Stateall
access_ip_list

1.6 - ListSnapshots

1.6.1 - 1.1

scp-cli parallel-filestorage snapshot list
--volume_id <value>

Description

List snapshots

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
volume_id
required		stringVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438

Responses

NameDescriptionExample
idSnapshot ID40htrre5b-eww25-ff2b-a426-6afefas65a3b
nameSnapshot Namesnapshot.2025-10-30_121212
size
stateSnapshot Stateavailable
created_atCreated At2024-10-30T04:54:33.219373

1.6.2 - 1.0

scp-cli parallel-filestorage snapshot list
--volume_id <value>

Description

List snapshots

State ACTIVE (SUPPORTED)

VersionNot Before
1.020261130

Parameters

NameTypeDescriptionExample
volume_id
required		stringVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438

Responses

NameDescriptionExample
idSnapshot ID40htrre5b-eww25-ff2b-a426-6afefas65a3b
nameSnapshot Namesnapshot.2025-10-30_121212
size
stateSnapshot Stateavailable
created_atCreated At2024-10-30T04:54:33.219373

1.7 - ListVolumes

1.7.1 - 1.1

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

Description

List volumes

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
offset
optional		integeroffset-
limit
optional		integerlimit-
name
optional		stringVolume Namemy_volume
sort
optional		stringsort-

Responses

NameDescriptionExample
idVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
nameVolume Namemy_volume
stateVolume Stateavailable
created_atCreated At2024-07-30T04:54:33.219373
capacity_tbVolume Capacity100
account_idAccount IDrwww523320dfvwbbefefsdvwdadsfa24c
zoneZonekr-west1-a

1.7.2 - 1.0

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

Description

List volumes

State ACTIVE (SUPPORTED)

VersionNot Before
1.020261130

Parameters

NameTypeDescriptionExample
offset
optional		integeroffset-
limit
optional		integerlimit-
name
optional		stringVolume Namemy_volume
sort
optional		stringsort-

Responses

NameDescriptionExample
idVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
nameVolume Namemy_volume
stateVolume Stateavailable
created_atCreated At2024-07-30T04:54:33.219373
capacity_tbVolume Capacity100
account_idAccount IDrwww523320dfvwbbefefsdvwdadsfa24c

1.8 - RestoreSnapshot

1.8.1 - 1.1

scp-cli parallel-filestorage volume snapshot set
--snapshot_id <value>
--volume_id <value>

Description

Restore snapshot

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
snapshot_id
required		stringSnapshot ID40htrre5b-eww25-ff2b-a426-6afefas65a3b
volume_id
required		stringVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438

1.8.2 - 1.0

scp-cli parallel-filestorage volume snapshot set
--snapshot_id <value>
--volume_id <value>

Description

Restore snapshot

State ACTIVE (SUPPORTED)

VersionNot Before
1.020261130

Parameters

NameTypeDescriptionExample
snapshot_id
required		stringSnapshot ID40htrre5b-eww25-ff2b-a426-6afefas65a3b
volume_id
required		stringVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438

1.9 - SetAccessRule

1.9.1 - 1.1

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

Description

Set access rule

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
volume_id
required		stringVolume IDbfdbabf2-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.9.2 - 1.0

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

Description

Set access rule

State ACTIVE (SUPPORTED)

VersionNot Before
1.020261130

Parameters

NameTypeDescriptionExample
volume_id
required		stringVolume IDbfdbabf2-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.1

scp-cli parallel-filestorage volume capacity set
--volume_id <value>
--capacity_tb <value>

Description

Set volume capacity

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
volume_id
required		stringVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
capacity_tb
required		integerVolume Capacity100

1.10.2 - 1.0

scp-cli parallel-filestorage volume capacity set
--volume_id <value>
--capacity_tb <value>

Description

Set volume capacity

State ACTIVE (SUPPORTED)

VersionNot Before
1.020261130

Parameters

NameTypeDescriptionExample
volume_id
required		stringVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
capacity_tb
required		integerVolume Capacity100

1.11 - ShowVolume

1.11.1 - 1.1

scp-cli parallel-filestorage volume show
--volume_id <value>

Description

Show volume

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

NameTypeDescriptionExample
volume_id
required		stringVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438

Responses

NameDescriptionExample
idVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
nameVolume Namemy_volume
stateVolume Stateavailable
created_atCreated At2024-07-30T04:54:33.219373
capacity_tbVolume Capacity100
account_idAccount IDrwww523320dfvwbbefefsdvwdadsfa24c
zoneZonekr-west1-a
mount_pathVolume Mount Pathxxx.xx.xxx:/xxxxxxxx

1.11.2 - 1.0

scp-cli parallel-filestorage volume show
--volume_id <value>

Description

Show volume

State ACTIVE (SUPPORTED)

VersionNot Before
1.020261130

Parameters

NameTypeDescriptionExample
volume_id
required		stringVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438

Responses

NameDescriptionExample
idVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
nameVolume Namemy_volume
stateVolume Stateavailable
created_atCreated At2024-07-30T04:54:33.219373
capacity_tbVolume Capacity100
account_idAccount IDrwww523320dfvwbbefefsdvwdadsfa24c
mount_pathVolume Mount Pathxxx.xx.xxx:/xxxxxxxx