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

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

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

VersionStatusNot Before
1.2CURRENT-

CLI Version History

1.2

Archive Storage CLI has been updated to version 1.2.

Changes

  • [New] archivestorage archiving policy delete - Delete archiving policy command has been added.
  • [Updated] archivestorage archiving policy create - The following request fields have been added and changed.
    • NEW archiving_policy_name - Added archiving policy name field.
    • RENAMED object-path -> archiving-prefix - The field name has been changed from object_path to archiving_prefix.
  • [Updated] archivestorage archiving policy set - The following request fields have been added and changed.
    • [REQUEST]
      • NEW archiving-policy-name - Added archiving policy name field.
    • [RESPONSE]
      • NEW
        • name -Archiving policy name.
      • CHANGED archiving - replaces the existing archiving_source.
        • 1.1: archiving_source -> bucket_name, object_path
        • 1.2: archiving -> source_bucket_name, prefix
  • [Updated] archivestorage archiving policy state set - The following response fields have been added and changed.
    • NEW name - Archiving policy name.
    • NEW object_lifecycle - Object lifecycle.
    • CHANGED archiving - Replaces the previous archiving_source.
      • 1.1: archiving_source -> bucket_name, object_path
      • 1.2: archiving -> source_bucket_name, prefix
  • [Updated] archivestorage archiving policy show - The following response fields have been added and changed.
    • 1.1: id,bucket_id,archiving_source (bucket_name, object_path) ,object_lifecycle, state
    • 1.2: bucket_id,archiving_source_bucket_name,archiving_policy(id,name,object_lifecycle,archiving_prefix,state)
  • [Updated] archivestorage archiving policy list - The following request and response fields have been added and changed.
    • [REQUEST]
      • NEW sort - Added sort query parameter.
    • [RESPONSE]
      • NEW name - Added archiving policy name column.
      • CHANGED archiving_prefix - Renamed from object_path.
  • [Updated] archivestorage archiving history show - The following response fields have been added and changed.
    • NEW archiving_policy_name - Added archiving policy name.
    • CHANGED archiving_prefix - Renamed from source_object_path.
  • [Updated] archivestorage archiving history list - The following request and response fields have been added.
    • NEW archiving_policy_id - Added archiving policy ID query parameter.
    • NEW archiving_policy_name - Added archiving policy name to response.
  • [Updated] archivestorage archiving policy show - The response structure has been changed.
    • 1.1: id, bucket_id, archiving_source (bucket_name, object_path), object_lifecycle, state
    • 1.2: bucket_id, archiving_source_bucket_name, archiving_policy (id, name, object_lifecycle, archiving_prefix, state)

1.1

Archive Storage CLI has been updated to version 1.1.

Changes

  • [New] archivestorage archiving policy state set - Set archiving policy state command has been added.
  • [New] archivestorage bucket object version delete - Delete bucket object versions command has been added.
  • [New] archivestorage bucket object version list - List bucket object versions command has been added.
  • [New] archivestorage bucket object recover versions - Recover object versions command has been added.
  • [New] archivestorage bucket versioning set - Set bucket versioning command has been added.
  • [New] archivestorage bucket versioning show - Show bucket versioning command has been added.

1.0

Archive Storage CLI has been released.

Changes

  • [New] archivestorage archiving history cancel - Cancel archiving command has been added.
  • [New] archivestorage archiving history list - List archiving histories command has been added.
  • [New] archivestorage archiving history show - Show archiving history command has been added.
  • [New] archivestorage archiving policy create - Create archiving policy command has been added.
  • [New] archivestorage archiving policy list - List archiving policies command has been added.
  • [New] archivestorage archiving policy set - Set archiving policy command has been added.
  • [New] archivestorage archiving policy show - Show archiving policy command has been added.
  • [New] archivestorage bucket create - Create bucket command has been added.
  • [New] archivestorage bucket delete - Delete bucket command has been added.
  • [New] archivestorage bucket encryption set - Set bucket encryption command has been added.
  • [New] archivestorage bucket encryption show - Show bucket encryption command has been added.
  • [New] archivestorage bucket list - List buckets command has been added.
  • [New] archivestorage bucket object delete - Delete bucket objects command has been added.
  • [New] archivestorage bucket object list - List bucket objects command has been added.
  • [New] archivestorage bucket object recover - Recover objects command has been added.
  • [New] archivestorage bucket show - Show bucket command has been added.
  • [New] archivestorage endpoint show - Show storage device endpoint command has been added.
  • [New] archivestorage recovery history cancel - Cancel recovery command has been added.
  • [New] archivestorage recovery history list - List recovery histories command has been added.
  • [New] archivestorage recovery history show - Show recovery history command has been added.

1.1 - CLIs

1.1.1 - CancelArchiving

1.1.1.1 - 1.2

scp-cli archivestorage archiving history cancel
--bucket_id <value>
--id <value>

Description

Cancel a specific archiving

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
bucket_id
required
stringBucket ID3d036efe-f576-48b0-8375-6d3704a95b63
id
required
stringArchiving History IDEXE-8f35b491-a060-453b-b825-e78440ca46de

1.1.2 - CancelRecovery

1.1.2.1 - 1.2

scp-cli archivestorage recovery history cancel
--bucket_id <value>
--id <value>

Description

Cancel a specific recovery

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
bucket_id
required
stringBucket ID7d8d8c2b-d02a-421e-a6e3-5b981bfb507f
id
required
stringRecovery History IDEXE-9df439a5-9e6d-46a4-806e-1e9991520763

1.1.3 - CreateArchivingPolicy

1.1.3.1 - 1.2

scp-cli archivestorage archiving policy create
--bucket_id <value>
--archiving_prefix <value>
--archiving_source_bucket_name <value>
--archiving_policy_name <value>
--object_lifecycle <value>

Description

Create an archivingPolicy

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
bucket_id
required
stringBucket ID138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
archiving_prefix
required
stringArchiving Prefix/
archiving_source_bucket_name
required
stringArchiving Source Bucket Nameobs-bucket-name
archiving_policy_name
required
stringArchiving Policy Namemy-policy
object_lifecycle
required
stringObject LifeCycle1

Responses

NameDescriptionExample
idArchiving Policy IDSCH-XXXXXXX
nameArchiving Policy Namemy-policy
bucket_idBucket ID138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
archivingArchiving
object_lifecycleObject LifeCycle1
stateArchiving Policy StateACTIVE

1.1.4 - CreateBucket

1.1.4.1 - 1.2

scp-cli archivestorage bucket create
--name <value>
[--tags <value>]

Description

Create a bucket

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
name
required
stringBucket nameastest
tags
optional
arrayTag List'{"key": "key", "value": "value"}'

Responses

NameDescriptionExample
idBucket ID138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2

1.1.5 - DeleteArchivingPolicy

1.1.5.1 - 1.2

scp-cli archivestorage archiving policy delete
--archiving_policy_id <value>
--bucket_id <value>

Description

Delete an archivingPolicy

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
archiving_policy_id
required
stringArchiving Policy IDSCH-XXXXXXX
bucket_id
required
stringBucket ID138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2

1.1.6 - DeleteBucket

1.1.6.1 - 1.2

scp-cli archivestorage bucket delete
--bucket_id <value>

Description

Delete a specific bucket

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
bucket_id
required
stringBucket ID138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2

1.1.7 - DeleteBucketObjects

1.1.7.1 - 1.2

scp-cli archivestorage bucket object delete
--bucket_id <value>
--paths <value>

Description

Delete Bucket Objects

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
bucket_id
required
stringBucket ID138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
paths
required
arrayObject Path Listtest/

1.1.8 - DeleteBucketObjectVersions

1.1.8.1 - 1.2

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

Description

Delete Bucket Object Versions

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
bucket_id
required
stringBucket ID138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
versions
required
arrayObject Version ListOc9nEYWV.6VjzsIMXFZWM1zL8HcYvKl
path
required
stringObject Pathhello/my_file.txt

1.1.9 - ListArchivingHistories

1.1.9.1 - 1.2

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

Description

List archiving histories

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
archiving_policy_id
required
stringArchiving Policy IDSCH-02d48456-0f35-47e2-8056-b00e09366cac
start_at_to
required
stringStart at to2025-04-30T23:59:59+09:00
start_at_from
required
stringStart at from2025-04-01T00:00:00+09:00
bucket_id
required
stringBucket ID3d036efe-f576-48b0-8375-6d3704a95b63
state
optional
stringStateSUCCESS
limit
optional
integerLimit20
offset
optional
integerOffset0

Responses

NameDescriptionExample
idArchiving History IDEXE-8f35b491-a060-453b-b825-e78440ca46de
archiving_idArchiving IDSCH-02d48456-0f35-47e2-8056-b00e09366cac
stateStateSUCCESS
archiving_policy_idArchiving Policy IDSCH-02d48456-0f35-47e2-8056-b00e09366cac
archiving_policy_nameArchiving Policy Namemy-policy
start_atStart at2025-04-01T00:00:00+09:00
end_atEnd at2025-04-30T23:59:59+09:00

1.1.10 - ListArchivingPolicies

1.1.10.1 - 1.2

scp-cli archivestorage archiving policy list
--bucket_id <value>
[--sort <value>]

Description

List archiving policies

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
bucket_id
required
stringBucket ID138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
sort
optional
stringSortname:asc

Responses

NameDescriptionExample
idArchiving Policy IDSCH-XXXXXXX
nameArchiving Policy Namemy-policy
object_lifecycleObject LifeCycle1
archiving_prefixArchiving Prefix/
stateArchiving Policy StateACTIVE

1.1.11 - ListBucketObjects

1.1.11.1 - 1.2

scp-cli 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)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
bucket_id
required
stringBucket ID138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
marker
optional
stringMarkerTODO.txt
object_path
optional
stringObject Path/
object_name
optional
stringObject Namehello/TODO.txt
object_type
optional
stringObject TypeFILE
limit
optional
integerLimit20

Responses

NameDescriptionExample
object_nameObject Namehello/TODO.txt
object_typeObject TypeFILE
object_sizeObject Size3581
modified_atModified AT2025-04-09T05:54:46.244000+00:00

1.1.12 - ListBucketObjectVersions

1.1.12.1 - 1.2

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

Description

List Bucket Object Versions

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
bucket_id
required
stringBucket ID138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
object_path
required
stringObject Pathhello/my_file.txt
offset
optional
integerOffset0
limit
optional
integerLimit20

Responses

NameDescriptionExample
object_pathObject Pathhello/my_file.txt
object_version_idObject Version IdOc9nEYWV.6VjzsIMXFZWM1zL8HcYvKl
latestIs Latest version of ObjectTrue
modified_atModified AT2025-04-09T05:54:46.244000+00:00
etagETag4f6094f1e0619a6504efcb5e69e63bec
sizeSize20

1.1.13 - ListBuckets

1.1.13.1 - 1.2

scp-cli archivestorage bucket list
[--name <value>]
[--limit <value>]

Description

List Buckets

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
name
optional
stringBucket nameastest
limit
optional
integerLimit20

Responses

NameDescriptionExample
idBucket ID138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
nameBucket nameastest

1.1.14 - ListRecoveryHistories

1.1.14.1 - 1.2

scp-cli 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)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
start_at_to
required
stringStart at to2025-04-30T23:59:59+09:00
start_at_from
required
stringStart at from2025-04-01T00:00:00+09:00
bucket_id
required
stringBucket ID7d8d8c2b-d02a-421e-a6e3-5b981bfb507f
state
optional
stringStateSUCCESS
limit
optional
integerLimit20
offset
optional
integerOffset0

Responses

NameDescriptionExample
idRecovery History IDEXE-9df439a5-9e6d-46a4-806e-1e9991520763
recovery_idRecovery IDARC-f9eab563-312b-4bbf-a4bf-d377448d66b5
stateStateSUCCESS
recovery_target_bucket_nameRecovery Target Bucket NAMEtest-obs-bucket
start_atStart at2025-04-01T00:00:00+09:00
end_atEnd at2025-04-30T23:59:59+09:00

1.1.15 - RecoverObjects

1.1.15.1 - 1.2

scp-cli 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)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
bucket_id
required
stringBucket ID138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
overwrite
required
booleanOverwriteTrue
recovery_infos
required
arrayObject Recovery Info List'{"source_object_path": "/", "object_type": "FILE"}'
recovery_target_bucket_name
required
stringRecovery Target Bucket Nameobs-bucket-name

1.1.16 - RecoverObjectVersions

1.1.16.1 - 1.2

scp-cli 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)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
bucket_id
required
stringBucket ID138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
overwrite
required
booleanOverwriteTrue
source_object_version
required
stringRecovery Source Object VersionOc9nEYWV.6VjzsIMXFZWM1zL8HcYvKl
source_object_path
required
stringRecovery Source Object Path/
recovery_target_bucket_name
required
stringRecovery Target Bucket Nameobs-bucket-name

1.1.17 - SetArchivingPolicy

1.1.17.1 - 1.2

scp-cli archivestorage archiving policy set
--archiving_policy_id <value>
--bucket_id <value>
--archiving_policy_name <value>
--object_lifecycle <value>

Description

Set archivingPolicy

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
archiving_policy_id
required
stringArchiving Policy IDSCH-XXXXXXX
bucket_id
required
stringBucket ID138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
archiving_policy_name
required
stringArchiving Policy Namemy-policy
object_lifecycle
required
stringObject LifeCycle1

1.1.18 - SetArchivingPolicyState

1.1.18.1 - 1.2

scp-cli archivestorage archiving policy state set
--archiving_policy_id <value>
--bucket_id <value>
--state <value>

Description

Set archivingPolicy state

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
archiving_policy_id
required
stringArchiving Policy IDSCH-XXXXXXX
bucket_id
required
stringBucket ID138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
state
required
stringArchiving Policy StateACTIVE

1.1.19 - SetBucketEncryption

1.1.19.1 - 1.2

scp-cli archivestorage bucket encryption set
--bucket_id <value>
--enabled <value>

Description

Set a specific bucket encryption

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
bucket_id
required
stringBucket ID138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
enabled
required
booleanEncryption EnabledTrue

1.1.20 - SetBucketVersioning

1.1.20.1 - 1.2

scp-cli archivestorage bucket versioning set
--bucket_id <value>
--enabled <value>

Description

set a specific bucket versioning

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
bucket_id
required
stringBucket ID138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
enabled
required
booleanVersioning EnabledTrue

1.1.21 - ShowArchivingHistory

1.1.21.1 - 1.2

scp-cli archivestorage archiving history show
--bucket_id <value>
--id <value>

Description

Show an archiving history

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
bucket_id
required
stringBucket ID3d036efe-f576-48b0-8375-6d3704a95b63
id
required
stringArchiving History IDEXE-8f35b491-a060-453b-b825-e78440ca46de

Responses

NameDescriptionExample
idArchiving History IDEXE-8f35b491-a060-453b-b825-e78440ca46de
archiving_idArchiving IDSCH-02d48456-0f35-47e2-8056-b00e09366cac
stateStateSUCCESS
archiving_policy_idArchiving Policy IDSCH-02d48456-0f35-47e2-8056-b00e09366cac
archiving_policy_nameArchiving Policy Namemy-policy
start_atStart at2025-04-01T00:00:00+09:00
end_atEnd at2025-04-30T23:59:59+09:00
bucket_idBucket ID3d036efe-f576-48b0-8375-6d3704a95b63
archiving_infosArchiving Info List[]

1.1.22 - ShowArchivingPolicy

1.1.22.1 - 1.2

scp-cli archivestorage archiving policy show
--archiving_policy_id <value>
--bucket_id <value>

Description

Show an archivingPolicy

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
archiving_policy_id
required
stringArchiving Policy IDSCH-XXXXXXX
bucket_id
required
stringBucket ID138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2

Responses

NameDescriptionExample
bucket_idBucket ID138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
archiving_source_bucket_nameArchiving Source Bucket Nameobs-bucket-name
archiving_policyArchiving Policy List{}

1.1.23 - ShowBucket

1.1.23.1 - 1.2

scp-cli archivestorage bucket show
--bucket_id <value>

Description

Show a specific bucket

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
bucket_id
required
stringBucket ID138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2

Responses

NameDescriptionExample
idBucket ID138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
nameBucket nameastest
stateBucket stateACTIVE
usageBucket usage10
archiving_source_bucket_nameArchiving source bucket nameobstest

1.1.24 - ShowBucketEncryption

1.1.24.1 - 1.2

scp-cli archivestorage bucket encryption show
--bucket_id <value>

Description

Show a specific bucket encryption

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
bucket_id
required
stringBucket ID138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2

Responses

NameDescriptionExample
idBucket ID138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
enabledEncryption EnabledTrue

1.1.25 - ShowBucketVersioning

1.1.25.1 - 1.2

scp-cli archivestorage bucket versioning show
--bucket_id <value>

Description

show a specific bucket versioning

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
bucket_id
required
stringBucket ID138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2

Responses

NameDescriptionExample
idBucket ID138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
enabledVersion EnabledTrue

1.1.26 - ShowRecoveryHistory

1.1.26.1 - 1.2

scp-cli archivestorage recovery history show
--bucket_id <value>
--id <value>

Description

Show a recovery history

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
bucket_id
required
stringBucket ID7d8d8c2b-d02a-421e-a6e3-5b981bfb507f
id
required
stringRecovery History IDEXE-9df439a5-9e6d-46a4-806e-1e9991520763

Responses

NameDescriptionExample
idRecovery History IDEXE-9df439a5-9e6d-46a4-806e-1e9991520763
recovery_idRecovery IDARC-f9eab563-312b-4bbf-a4bf-d377448d66b5
stateStateSUCCESS
recovery_target_bucket_nameRecovery Target Bucket NAMEtest-obs-bucket
start_atStart at2025-04-01T00:00:00+09:00
end_atEnd at2025-04-30T23:59:59+09:00
bucket_idBucket ID7d8d8c2b-d02a-421e-a6e3-5b981bfb507f
recovery_infosRecovery Info List[]

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

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

VersionStatusNot Before
1.3CURRENT-
1.2SUPPORTED20261231
1.1DEPRECATED20260531
1.0DEPRECATED20260331

CLI Version History

1.3

Backup CLI has been released.

Changes

  • [New] backup_backup_agent_list - command has been added.
  • [New] backup_backup_agent_create - command has been added.
  • [New] backup_backup_agent_install_file_path_show - command has been added.
  • [New] backup_backup_agent_target_list - command has been added.
  • [New] backup_backup_agent_delete - command has been added.
  • [New] backup_backup_agent_show - command has been added.
  • [New] backup_backup_agent_connection_state_check - command has been added.
  • [New] backup_backup_list - command has been added.
  • [New] backup_backup_create - command has been added.
  • [New] backup_backup_target_list - command has been added.
  • [New] backup_backup_agent_filesystem_duplication_check - command has been added.
  • [New] backup_backup_name_duplicate_check - command has been added.
  • [New] backup_backup_region_relationship_list - command has been added.
  • [New] backup_backup_restore_server_name_duplicate_check - command has been added.
  • [New] backup_backup_delete - command has been added.
  • [New] backup_backup_show - command has been added.
  • [New] backup_agent_backup_restore_target_server_list - command has been added.
  • [New] backup_backup_history_list - command has been added.
  • [New] backup_backup_agent_filesystem_path_set - command has been added.
  • [New] backup_backup_manual_backup_create - command has been added.
  • [New] backup_backup_replication_use_set - command has been added.
  • [New] backup_backup_restore - command has been added.
  • [New] backup_agent_backup_restore - command has been added.
  • [New] backup_backup_restore_history_list - command has been added.
  • [New] backup_backup_restore_target_delete - command has been added.
  • [New] backup_backup_restore_target_list - command has been added.
  • [New] backup_backup_restore_subnet_list - command has been added.
  • [New] backup_backup_retention_period_set - command has been added.
  • [New] backup_backup_schedule_list - command has been added.
  • [New] backup_backup_schedule_set - command has been added.
  • [New] backup_backup_agent_filesystem_path_list - command has been added.

2.1 - CLIs

2.1.1 - Check Backup Master Connection State

2.1.1.1 - 1.3

scp-cli backup backup agent connection state check
--backup_agent_id <value>

Description

Check Backup master connection state.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
backup_agent_id
required
stringBackup Agent IDBACKUP_AGENT-abcd

Responses

NameDescriptionExample
request_idRequest ID
resourceResource

2.1.1.2 - 1.2

scp-cli backup backup agent connection state check
--backup_agent_id <value>

Description

Check Backup master connection state.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261231

Parameters

NameTypeDescriptionExample
backup_agent_id
required
stringBackup Agent IDBACKUP_AGENT-abcd

Responses

NameDescriptionExample
request_idRequest ID
resourceResource

2.1.1.3 - 1.1

scp-cli backup backup agent connection state check
--backup_agent_id <value>

Description

Check Backup master connection state.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
backup_agent_id
required
stringBackup Agent IDBACKUP_AGENT-abcd

Responses

NameDescriptionExample
request_idRequest ID
resourceResource

2.1.1.4 - 1.0

scp-cli backup backup agent connection state check
--backup_agent_id <value>

Description

Check Backup master connection state.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260331

Parameters

NameTypeDescriptionExample
backup_agent_id
required
stringBackup Agent IDBACKUP_AGENT-abcd

Responses

NameDescriptionExample
request_idRequest ID
resourceResource

2.1.2 - Check Backup Name Duplicate

2.1.2.1 - 1.3

scp-cli backup backup name duplicate check
--backup_name <value>

Description

Check for duplicate backup names.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
backup_name
required
stringBackup namebackup-001

Responses

NameDescriptionExample
resultResultTrue

2.1.2.2 - 1.2

scp-cli backup backup name duplicate check
--backup_name <value>

Description

Check for duplicate backup names.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261231

Parameters

NameTypeDescriptionExample
backup_name
required
stringBackup namebackup-001

Responses

NameDescriptionExample
resultResultTrue

2.1.2.3 - 1.1

scp-cli backup backup name duplicate check
--backup_name <value>

Description

Check for duplicate backup names.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
backup_name
required
stringBackup namebackup-001

Responses

NameDescriptionExample
resultResultTrue

2.1.2.4 - 1.0

scp-cli backup backup name duplicate check
--backup_name <value>

Description

Check for duplicate backup names.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260331

Parameters

NameTypeDescriptionExample
backup_name
required
stringBackup namebackup-001

Responses

NameDescriptionExample
resultResultTrue

2.1.3 - Check Backup Restore Server Name Duplicate

2.1.3.1 - 1.3

scp-cli backup backup restore server name duplicate check
--restore_server_name <value>

Description

Check for duplicate restore server name.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
restore_server_name
required
stringRestore server namerestoretest1

Responses

NameDescriptionExample
resultResultTrue

2.1.3.2 - 1.2

scp-cli backup backup restore server name duplicate check
--restore_server_name <value>

Description

Check for duplicate restore server name.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261231

Parameters

NameTypeDescriptionExample
restore_server_name
required
stringRestore server namerestoretest1

Responses

NameDescriptionExample
resultResultTrue

2.1.3.3 - 1.1

scp-cli backup backup restore server name duplicate check
--restore_server_name <value>

Description

Check for duplicate restore server name.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
restore_server_name
required
stringRestore server namerestoretest1

Responses

NameDescriptionExample
resultResultTrue

2.1.3.4 - 1.0

scp-cli backup backup restore server name duplicate check
--restore_server_name <value>

Description

Check for duplicate restore server name.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260331

Parameters

NameTypeDescriptionExample
restore_server_name
required
stringRestore server namerestoretest1

Responses

NameDescriptionExample
resultResultTrue

2.1.4 - Check Filesystem Path Duplication

2.1.4.1 - 1.3

scp-cli backup backup agent filesystem duplication check
--server_uuid <value>
--filesystem_path <value>

Description

Check filesystem path duplication.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
server_uuid
required
stringBackup server UUID89f5ef44-1021-4a5c-8e06-fbb289eac366
filesystem_path
required
stringFilesystem backup path/aaa

Responses

NameDescriptionExample
resultResultTrue

2.1.4.2 - 1.2

scp-cli backup backup agent filesystem duplication check
--server_uuid <value>
--filesystem_path <value>

Description

Check filesystem path duplication.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261231

Parameters

NameTypeDescriptionExample
server_uuid
required
stringBackup server UUID89f5ef44-1021-4a5c-8e06-fbb289eac366
filesystem_path
required
stringFilesystem backup path/aaa

Responses

NameDescriptionExample
resultResultTrue

2.1.4.3 - 1.1

scp-cli backup backup agent filesystem duplication check
--server_uuid <value>
--filesystem_path <value>

Description

Check filesystem path duplication.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
server_uuid
required
stringBackup server UUID89f5ef44-1021-4a5c-8e06-fbb289eac366
filesystem_path
required
stringFilesystem backup path/aaa

Responses

NameDescriptionExample
resultResultTrue

2.1.4.4 - 1.0

scp-cli backup backup agent filesystem duplication check
--server_uuid <value>
--filesystem_path <value>

Description

Check filesystem path duplication.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260331

Parameters

NameTypeDescriptionExample
server_uuid
required
stringBackup server UUID89f5ef44-1021-4a5c-8e06-fbb289eac366
filesystem_path
required
stringFilesystem backup path/aaa

Responses

NameDescriptionExample
resultResultTrue

2.1.5 - Create Backup

2.1.5.1 - 1.3

scp-cli 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>]
[--is_all_filesystem <value>]
[--region <value>]
[--retention_period <value>]
[--server_guid <value>]
[--tags <value>]
[--zone <value>]

Description

Create a Backup.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
server_uuid
required
stringBackup server UUID89f5ef44-1021-4a5c-8e06-fbb289eac366
server_category
required
stringBackup server category```VIRTUAL_SERVER
schedules
required
arraySchedules'{"frequency": "DAILY", "start_day": "MON", "start_time": "09:00:00", "start_week": "WEEK_2", "type": "FULL"}'
policy_type
required
stringBackup policy typeVM_IMAGE
policy_category
required
stringBackup policy categoryAGENTLESS
name
required
stringBackup namebackup-001
dr_enabled
optional
booleanWhether to use DR-
encrypt_enabled
optional
booleanWhether to use EncryptionTrue
filesystem_paths
optional
arrayList of filesystem backup path/aaa
is_all_filesystem
optional
booleanWhether to target the all filesystem-
region
optional
stringFor Agentless Backup, this is the region where the backup is stored. For Agent Backup, this is the region to which the backup will be replicated.kr-west1
retention_period
optional
stringBackup retention periodWEEK_2
server_guid
optional
stringBackup server GUID9ab33c66-3dbd-46cd-b0af-abccd3eb3170
tags
optional
array'{"key": "", "value": ""}'
zone
optional
stringFor Agentless Backup, this is the zone where the backup is stored. For Agent Backup, this is the zone to which the backup will be replicated.-

Responses

NameDescriptionExample
request_idRequest ID
resourceResource

2.1.5.2 - 1.2

scp-cli 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>]
[--is_all_filesystem <value>]
[--region <value>]
[--retention_period <value>]
[--server_guid <value>]
[--tags <value>]

Description

Create a Backup.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261231

Parameters

NameTypeDescriptionExample
server_uuid
required
stringBackup server UUID89f5ef44-1021-4a5c-8e06-fbb289eac366
server_category
required
stringBackup server category```VIRTUAL_SERVER
schedules
required
arraySchedules'{"frequency": "DAILY", "start_day": "MON", "start_time": "09:00:00", "start_week": "WEEK_2", "type": "FULL"}'
policy_type
required
stringBackup policy typeVM_IMAGE
policy_category
required
stringBackup policy categoryAGENTLESS
name
required
stringBackup namebackup-001
dr_enabled
optional
booleanWhether to use DR-
encrypt_enabled
optional
booleanWhether to use EncryptionTrue
filesystem_paths
optional
arrayList of filesystem backup path/aaa
is_all_filesystem
optional
booleanWhether to target the all filesystem-
region
optional
stringFor Agentless Backup, this is the region where the backup is stored. For Agent Backup, this is the region to which the backup will be replicated.kr-west1
retention_period
optional
stringBackup retention periodWEEK_2
server_guid
optional
stringBackup server GUID9ab33c66-3dbd-46cd-b0af-abccd3eb3170
tags
optional
array'{"key": "", "value": ""}'

Responses

NameDescriptionExample
request_idRequest ID
resourceResource

2.1.5.3 - 1.1

scp-cli 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 (DEPRECATED)

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

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
server_uuid
required
stringBackup server UUID89f5ef44-1021-4a5c-8e06-fbb289eac366
server_category
required
stringBackup server category```VIRTUAL_SERVER
schedules
required
arraySchedules'{"frequency": "DAILY", "start_day": "MON", "start_time": "09:00:00", "start_week": "WEEK_2", "type": "FULL"}'
policy_type
required
stringBackup policy typeVM_IMAGE
policy_category
required
stringBackup policy categoryAGENTLESS
name
required
stringBackup namebackup-001
dr_enabled
optional
booleanWhether to use DR-
encrypt_enabled
optional
booleanWhether to use EncryptionTrue
filesystem_paths
optional
arrayList of filesystem backup path/aaa
region
optional
stringFor Agentless Backup, this is the region where the backup is stored. For Agent Backup, this is the region to which the backup will be replicated.kr-west1
retention_period
optional
stringBackup retention periodWEEK_2
server_guid
optional
stringBackup server GUID9ab33c66-3dbd-46cd-b0af-abccd3eb3170
tags
optional
array'{"key": "", "value": ""}'

Responses

NameDescriptionExample
request_idRequest ID
resourceResource

2.1.5.4 - 1.0

scp-cli 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)

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

VersionNot Before
1.020260331

Parameters

NameTypeDescriptionExample
server_uuid
required
stringBackup server UUID89f5ef44-1021-4a5c-8e06-fbb289eac366
server_category
required
stringBackup server category```VIRTUAL_SERVER
schedules
required
arraySchedules'{"frequency": "DAILY", "start_day": "MON", "start_time": "09:00:00", "start_week": "WEEK_2", "type": "FULL"}'
policy_type
required
stringBackup policy typeVM_IMAGE
policy_category
required
stringBackup policy categoryAGENTLESS
name
required
stringBackup namebackup-001
encrypt_enabled
optional
booleanWhether to use EncryptionTrue
filesystem_paths
optional
arrayList of filesystem backup path/aaa
region
optional
stringFor Agentless Backup, this is the region where the backup is stored. For Agent Backup, this is the region to which the backup will be replicated.kr-west1
retention_period
optional
stringBackup retention periodWEEK_2
server_guid
optional
stringBackup server GUID9ab33c66-3dbd-46cd-b0af-abccd3eb3170
tags
optional
array'{"key": "", "value": ""}'

Responses

NameDescriptionExample
request_idRequest ID
resourceResource

2.1.6 - Create Backup Agent

2.1.6.1 - 1.3

scp-cli backup backup agent create
--zone <value>
--server_uuid <value>
--server_backup_agent_ip <value>
[--subnet_id <value>]
[--tags <value>]

Description

Create a Backup Agent.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
zone
required
stringAvailability zone namekr-west1-a
server_uuid
required
stringBackup Agent target server UUID89f5ef44-1021-4a5c-8e06-fbb289eac366
server_backup_agent_ip
required
stringServer's Backup Agent IP11.22.33.44
subnet_id
optional
stringSubnet ID023c57b14f11483689338d085e061492
tags
optional
array'{"key": "", "value": ""}'

Responses

NameDescriptionExample
request_idRequest ID
resourceResource

2.1.6.2 - 1.2

scp-cli backup backup agent create
--server_uuid <value>
[--subnet_id <value>]
[--tags <value>]

Description

Create a Backup Agent.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261231

Parameters

NameTypeDescriptionExample
server_uuid
required
stringBackup Agent target server UUID89f5ef44-1021-4a5c-8e06-fbb289eac366
subnet_id
optional
stringSubnet ID023c57b14f11483689338d085e061492
tags
optional
array'{"key": "", "value": ""}'

Responses

NameDescriptionExample
request_idRequest ID
resourceResource

2.1.6.3 - 1.1

scp-cli backup backup agent create
--server_uuid <value>
[--tags <value>]

Description

Create a Backup Agent.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
server_uuid
required
stringBackup Agent target server UUID89f5ef44-1021-4a5c-8e06-fbb289eac366
tags
optional
array'{"key": "", "value": ""}'

Responses

NameDescriptionExample
request_idRequest ID
resourceResource

2.1.6.4 - 1.0

scp-cli backup backup agent create
--server_uuid <value>
[--tags <value>]

Description

Create a Backup Agent.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260331

Parameters

NameTypeDescriptionExample
server_uuid
required
stringBackup Agent target server UUID89f5ef44-1021-4a5c-8e06-fbb289eac366
tags
optional
array'{"key": "", "value": ""}'

Responses

NameDescriptionExample
request_idRequest ID
resourceResource

2.1.7 - Delete Backup

2.1.7.1 - 1.3

scp-cli backup backup delete
--backup_id <value>

Description

Terminate the Backup.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974

2.1.7.2 - 1.2

scp-cli backup backup delete
--backup_id <value>

Description

Terminate the Backup.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261231

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974

2.1.7.3 - 1.1

scp-cli backup backup delete
--backup_id <value>

Description

Terminate the Backup.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974

2.1.7.4 - 1.0

scp-cli backup backup delete
--backup_id <value>

Description

Terminate the Backup.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260331

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974

2.1.8 - Delete Backup Agent

2.1.8.1 - 1.3

scp-cli backup backup agent delete
--backup_agent_id <value>

Description

Terminate the Backup Agent.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
backup_agent_id
required
stringBackup Agent IDBACKUP_AGENT-abcd

2.1.8.2 - 1.2

scp-cli backup backup agent delete
--backup_agent_id <value>

Description

Terminate the Backup Agent.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261231

Parameters

NameTypeDescriptionExample
backup_agent_id
required
stringBackup Agent IDBACKUP_AGENT-abcd

2.1.8.3 - 1.1

scp-cli backup backup agent delete
--backup_agent_id <value>

Description

Terminate the Backup Agent.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
backup_agent_id
required
stringBackup Agent IDBACKUP_AGENT-abcd

2.1.8.4 - 1.0

scp-cli backup backup agent delete
--backup_agent_id <value>

Description

Terminate the Backup Agent.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260331

Parameters

NameTypeDescriptionExample
backup_agent_id
required
stringBackup Agent IDBACKUP_AGENT-abcd

2.1.9 - Delete Backup Restore Target

2.1.9.1 - 1.3

scp-cli backup backup restore target delete
--backup_id <value>
--restore_target_ids <value>

Description

Delete Backup restore target.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
restore_target_ids
required
arrayBackup restore target ID listca1a8e76-af49-40ea-93f8-a5989ffe138b

2.1.9.2 - 1.2

scp-cli backup backup restore target delete
--backup_id <value>
--restore_target_ids <value>

Description

Delete Backup restore target.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261231

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
restore_target_ids
required
arrayBackup restore target ID listca1a8e76-af49-40ea-93f8-a5989ffe138b

2.1.9.3 - 1.1

scp-cli backup backup restore target delete
--backup_id <value>
--restore_target_ids <value>

Description

Delete Backup restore target.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
restore_target_ids
required
arrayBackup restore target ID listca1a8e76-af49-40ea-93f8-a5989ffe138b

2.1.9.4 - 1.0

scp-cli backup backup restore target delete
--backup_id <value>
--restore_target_ids <value>

Description

Delete Backup restore target.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260331

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
restore_target_ids
required
arrayBackup restore target ID listca1a8e76-af49-40ea-93f8-a5989ffe138b

2.1.10 - List Agent Backup Restore Target Servers

2.1.10.1 - 1.3

scp-cli 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)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
server_name
optional
stringBackup server nameserver-001
page
optional
integerPage0
size
optional
integerSize20

Responses

NameDescriptionExample
server_nameBackup server nameserver-001
server_os_versionServer’s OS Type and VersionUBUNTU 22.04
server_typeBackup server types1v1m2
server_uuidBackup server UUID89f5ef44-1021-4a5c-8e06-fbb289eac366

2.1.10.2 - 1.2

scp-cli 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 (SUPPORTED)

VersionNot Before
1.220261231

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
server_name
optional
stringBackup server nameserver-001
page
optional
integerPage0
size
optional
integerSize20

Responses

NameDescriptionExample
server_nameBackup server nameserver-001
server_os_versionServer’s OS Type and VersionUBUNTU 22.04
server_typeBackup server types1v1m2
server_uuidBackup server UUID89f5ef44-1021-4a5c-8e06-fbb289eac366

2.1.10.3 - 1.1

scp-cli 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)

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

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
server_name
optional
stringBackup server nameserver-001
page
optional
integerPage0
size
optional
integerSize20

Responses

NameDescriptionExample
server_nameBackup server nameserver-001
server_os_versionServer’s OS Type and VersionUBUNTU 22.04
server_uuidBackup server UUID89f5ef44-1021-4a5c-8e06-fbb289eac366

2.1.10.4 - 1.0

scp-cli 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)

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

VersionNot Before
1.020260331

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
server_name
optional
stringBackup server nameserver-001
page
optional
integerPage0
size
optional
integerSize20

Responses

NameDescriptionExample
server_nameBackup server nameserver-001
server_os_versionServer’s OS Type and VersionUBUNTU 22.04
server_uuidBackup server UUID89f5ef44-1021-4a5c-8e06-fbb289eac366

2.1.11 - List Backup Agents

2.1.11.1 - 1.3

scp-cli 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)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringBackup Agent Nameagent_abcd12
server_backup_agent_ip
optional
stringServer's Backup Agent IP11.22.33.44
server_name
optional
stringBackup Agent target server nameserver-001

Responses

NameDescriptionExample
idBackup Agent IDBACKUP_AGENT-abcd
account_idAccount IDfnsd89fus0f9ds09f90dshf9dshfds09
backup_policy_countBackup policy count3
connection_stateBackup Agent connection stateSUCCESS
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameBackup Agent Nameagent_abcd12
server_backup_agent_ipServer’s Backup Agent IP11.22.33.44
server_categoryBackup server categoryVIRTUAL_SERVER
server_nameBackup server nameserver-001
stateBackup Agent stateAVAILABLE

2.1.11.2 - 1.2

scp-cli 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 (SUPPORTED)

VersionNot Before
1.220261231

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringBackup Agent Nameagent_abcd12
server_backup_agent_ip
optional
stringServer's Backup Agent IP11.22.33.44
server_name
optional
stringBackup Agent target server nameserver-001

Responses

NameDescriptionExample
idBackup Agent IDBACKUP_AGENT-abcd
account_idAccount IDfnsd89fus0f9ds09f90dshf9dshfds09
backup_policy_countBackup policy count3
connection_stateBackup Agent connection stateSUCCESS
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameBackup Agent Nameagent_abcd12
server_backup_agent_ipServer’s Backup Agent IP11.22.33.44
server_categoryBackup server categoryVIRTUAL_SERVER
server_nameBackup server nameserver-001
stateBackup Agent stateAVAILABLE

2.1.11.3 - 1.1

scp-cli 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)

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

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringBackup Agent Nameagent_abcd12
server_backup_agent_ip
optional
stringServer's Backup Agent IP11.22.33.44
server_name
optional
stringBackup Agent target server nameserver-001

Responses

NameDescriptionExample
idBackup Agent IDBACKUP_AGENT-abcd
account_idAccount IDfnsd89fus0f9ds09f90dshf9dshfds09
backup_policy_countBackup policy count3
connection_stateBackup Agent connection stateSUCCESS
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameBackup Agent Nameagent_abcd12
server_backup_agent_ipServer’s Backup Agent IP11.22.33.44
server_nameBackup server nameserver-001
stateBackup Agent stateAVAILABLE

2.1.11.4 - 1.0

scp-cli 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)

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

VersionNot Before
1.020260331

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringBackup Agent Nameagent_abcd12
server_backup_agent_ip
optional
stringServer's Backup Agent IP11.22.33.44
server_name
optional
stringBackup Agent target server nameserver-001

Responses

NameDescriptionExample
idBackup Agent IDBACKUP_AGENT-abcd
account_idAccount IDfnsd89fus0f9ds09f90dshf9dshfds09
backup_policy_countBackup policy count3
connection_stateBackup Agent connection stateSUCCESS
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameBackup Agent Nameagent_abcd12
server_backup_agent_ipServer’s Backup Agent IP11.22.33.44
server_nameBackup server nameserver-001
stateBackup Agent stateAVAILABLE

2.1.12 - List Backup Histories

2.1.12.1 - 1.3

scp-cli 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)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
backup_start_time
optional
stringStart time2024-09-30T15:00:00Z
backup_end_time
optional
stringEnd time2024-10-31T14:59:59Z
backup_job_state
optional
****Backup history stateSUCCESS
page
optional
integerPage0
size
optional
integerSize20
sort
optional
stringSortbackup_start_time:desc

Responses

NameDescriptionExample
backup_end_timeEnd time2024-10-31T14:59:59Z
backup_job_guidBackup job GUID3b1da7ba-3f38-45cb-9538-e921826f80d7
backup_job_stateBackup history stateSUCCESS
backup_start_timeStart time2024-09-30T15:00:00Z
schedule_idSchedule IDf5b8e22b-0d88-4698-9996-fb44217c8227
schedule_nameSchedule nameINCREMENTAL_DAILY_15:00:00-chg4By

2.1.12.2 - 1.2

scp-cli 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 (SUPPORTED)

VersionNot Before
1.220261231

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
backup_start_time
optional
stringStart time2024-09-30T15:00:00Z
backup_end_time
optional
stringEnd time2024-10-31T14:59:59Z
backup_job_state
optional
****Backup history stateSUCCESS
page
optional
integerPage0
size
optional
integerSize20
sort
optional
stringSortbackup_start_time:desc

Responses

NameDescriptionExample
backup_end_timeEnd time2024-10-31T14:59:59Z
backup_job_guidBackup job GUID3b1da7ba-3f38-45cb-9538-e921826f80d7
backup_job_stateBackup history stateSUCCESS
backup_start_timeStart time2024-09-30T15:00:00Z
schedule_idSchedule IDf5b8e22b-0d88-4698-9996-fb44217c8227
schedule_nameSchedule nameINCREMENTAL_DAILY_15:00:00-chg4By

2.1.12.3 - 1.1

scp-cli 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)

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

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
backup_start_time
optional
stringStart time2024-09-30T15:00:00Z
backup_end_time
optional
stringEnd time2024-10-31T14:59:59Z
backup_job_state
optional
****Backup history stateSUCCESS
page
optional
integerPage0
size
optional
integerSize20
sort
optional
stringSortbackup_start_time:desc

Responses

NameDescriptionExample
backup_end_timeEnd time2024-10-31T14:59:59Z
backup_job_guidBackup job GUID3b1da7ba-3f38-45cb-9538-e921826f80d7
backup_job_stateBackup history stateSUCCESS
backup_start_timeStart time2024-09-30T15:00:00Z
schedule_idSchedule IDf5b8e22b-0d88-4698-9996-fb44217c8227
schedule_nameSchedule nameINCREMENTAL_DAILY_15:00:00-chg4By

2.1.12.4 - 1.0

scp-cli 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)

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

VersionNot Before
1.020260331

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
backup_start_time
optional
stringStart time2024-09-30T15:00:00Z
backup_end_time
optional
stringEnd time2024-10-31T14:59:59Z
backup_job_state
optional
****Backup history stateSUCCESS
page
optional
integerPage0
size
optional
integerSize20
sort
optional
stringSortbackup_start_time:desc

Responses

NameDescriptionExample
backup_end_timeEnd time2024-10-31T14:59:59Z
backup_job_guidBackup job GUID3b1da7ba-3f38-45cb-9538-e921826f80d7
backup_job_stateBackup history stateSUCCESS
backup_start_timeStart time2024-09-30T15:00:00Z
schedule_idSchedule IDf5b8e22b-0d88-4698-9996-fb44217c8227
schedule_nameSchedule nameINCREMENTAL_DAILY_15:00:00-chg4By

2.1.13 - List Backup Region Relationship

2.1.13.1 - 1.3

scp-cli backup backup region relationship list
[--from_region <value>]
[--from_zone <value>]
[--to_region <value>]
[--to_zone <value>]
[--backup_master_type <value>]

Description

List Backup Region Relationship.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
from_region
optional
stringRegionkr-west1
from_zone
optional
stringAvailability zone namekr-west1-a
to_region
optional
stringRegionkr-west1
to_zone
optional
stringAvailability zone namekr-west1-a
backup_master_type
optional
****Backup Master typeAGENTLESS

Responses

NameDescriptionExample
from_regionRegionkr-west1
from_zoneAvailability zone namekr-west1-a
to_regionRegionkr-west1
to_zoneAvailability zone namekr-west1-a

2.1.13.2 - 1.2

scp-cli 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 (SUPPORTED)

VersionNot Before
1.220261231

Parameters

NameTypeDescriptionExample
from_region
optional
stringRegionkr-west1
from_availability_zone
optional
stringAvailability zone namekr-west1-a
to_region
optional
stringRegionkr-west1
to_availability_zone
optional
stringAvailability zone namekr-west1-a
backup_master_type
optional
****Backup Master typeAGENTLESS

Responses

NameDescriptionExample
from_availability_zoneAvailability zone namekr-west1-a
from_regionRegionkr-west1
to_availability_zoneAvailability zone namekr-west1-a
to_regionRegionkr-west1

2.1.13.3 - 1.1

scp-cli 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 (DEPRECATED)

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

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
from_region
optional
stringRegionkr-west1
from_availability_zone
optional
stringAvailability zone namekr-west1-a
to_region
optional
stringRegionkr-west1
to_availability_zone
optional
stringAvailability zone namekr-west1-a
backup_master_type
optional
****Backup Master typeAGENTLESS

Responses

NameDescriptionExample
from_availability_zoneAvailability zone namekr-west1-a
from_regionRegionkr-west1
to_availability_zoneAvailability zone namekr-west1-a
to_regionRegionkr-west1

2.1.13.4 - 1.0

scp-cli 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)

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

VersionNot Before
1.020260331

Parameters

NameTypeDescriptionExample
from_region
optional
stringRegionkr-west1
from_availability_zone
optional
stringAvailability zone namekr-west1-a
to_region
optional
stringRegionkr-west1
to_availability_zone
optional
stringAvailability zone namekr-west1-a

Responses

NameDescriptionExample
from_availability_zoneAvailability zone namekr-west1-a
from_regionRegionkr-west1
to_availability_zoneAvailability zone namekr-west1-a
to_regionRegionkr-west1

2.1.14 - List Backup Restore Histories

2.1.14.1 - 1.3

scp-cli 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)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
page
optional
integerPage0
size
optional
integerSize20
sort
optional
stringSortbackup_start_time:desc
restore_state
optional
****Restore stateCOMPLETED
start_time
optional
stringStart time2024-09-30T15:00:00Z
end_time
optional
stringEnd time2024-10-31T14:59:59Z

Responses

NameDescriptionExample
backup_idBackup ID00cd2538fbf94d12b36aabbdd607e974
backup_start_timeBackup time2024-10-28T05:38:48
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
restore_end_timeRestore completion time2024-10-28T05:52:47
restore_server_idRestored server ID26895cb7-2059-49e7-b6fe-9c9c4b0d3db0
restore_server_nameRestore server namerestoretest1
restore_start_timeRestore start time2024-10-28T05:52:47
restore_stateRestore stateCOMPLETED
schedule_nameSchedule nameINCREMENTAL_DAILY_15:00:00-chg4By

2.1.14.2 - 1.2

scp-cli 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 (SUPPORTED)

VersionNot Before
1.220261231

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
page
optional
integerPage0
size
optional
integerSize20
sort
optional
stringSortbackup_start_time:desc
restore_state
optional
****Restore stateCOMPLETED
start_time
optional
stringStart time2024-09-30T15:00:00Z
end_time
optional
stringEnd time2024-10-31T14:59:59Z

Responses

NameDescriptionExample
backup_idBackup ID00cd2538fbf94d12b36aabbdd607e974
backup_start_timeBackup time2024-10-28T05:38:48
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
restore_end_timeRestore completion time2024-10-28T05:52:47
restore_server_idRestored server ID26895cb7-2059-49e7-b6fe-9c9c4b0d3db0
restore_server_nameRestore server namerestoretest1
restore_start_timeRestore start time2024-10-28T05:52:47
restore_stateRestore stateCOMPLETED
schedule_nameSchedule nameINCREMENTAL_DAILY_15:00:00-chg4By

2.1.14.3 - 1.1

scp-cli 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)

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

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
page
optional
integerPage0
size
optional
integerSize20
sort
optional
stringSortbackup_start_time:desc
restore_state
optional
****Restore stateCOMPLETED
start_time
optional
stringStart time2024-09-30T15:00:00Z
end_time
optional
stringEnd time2024-10-31T14:59:59Z

Responses

NameDescriptionExample
backup_idBackup ID00cd2538fbf94d12b36aabbdd607e974
backup_start_timeBackup time2024-10-28T05:38:48
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
restore_end_timeRestore completion time2024-10-28T05:52:47
restore_server_idRestored server ID26895cb7-2059-49e7-b6fe-9c9c4b0d3db0
restore_server_nameRestore server namerestoretest1
restore_start_timeRestore start time2024-10-28T05:52:47
restore_stateRestore stateCOMPLETED
schedule_nameSchedule nameINCREMENTAL_DAILY_15:00:00-chg4By

2.1.14.4 - 1.0

scp-cli 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)

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

VersionNot Before
1.020260331

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
page
optional
integerPage0
size
optional
integerSize20
sort
optional
stringSortbackup_start_time:desc
restore_state
optional
****Restore stateCOMPLETED
start_time
optional
stringStart time2024-09-30T15:00:00Z
end_time
optional
stringEnd time2024-10-31T14:59:59Z

Responses

NameDescriptionExample
backup_idBackup ID00cd2538fbf94d12b36aabbdd607e974
backup_start_timeBackup time2024-10-28T05:38:48
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
restore_end_timeRestore completion time2024-10-28T05:52:47
restore_server_idRestored server ID26895cb7-2059-49e7-b6fe-9c9c4b0d3db0
restore_server_nameRestore server namerestoretest1
restore_start_timeRestore start time2024-10-28T05:52:47
restore_stateRestore stateCOMPLETED
schedule_nameSchedule nameINCREMENTAL_DAILY_15:00:00-chg4By

2.1.15 - List Backup Restore Subnets

2.1.15.1 - 1.3

scp-cli backup backup restore subnet list
--backup_id <value>
--region <value>
[--vpc_id <value>]
[--state <value>]
[--zone <value>]

Description

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

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
region
required
stringRegion to restore serverkr-west1
vpc_id
optional
stringVPC ID7df8abb4912e4709b1cb237daccca7a8
state
optional
stringSubnet stateACTIVE
zone
optional
stringAvailability zone namekr-west1-a

Responses

NameDescriptionExample
idSubnet ID023c57b14f11483689338d085e061492
account_idAccount IDfnsd89fus0f9ds09f90dshf9dshfds09
cidrSubnet Cidr192.167.1.0/24
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
gateway_ip_addressGateway IP Address192.167.1.1
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSubnet NamesubnetName
stateSubnet stateACTIVE
typeSubnet TypePUBLIC
vpc_idVPC ID7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC namevpcName

2.1.15.2 - 1.2

scp-cli 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 (SUPPORTED)

VersionNot Before
1.220261231

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
region
required
stringRegion to restore serverkr-west1
vpc_id
optional
stringVPC ID7df8abb4912e4709b1cb237daccca7a8
state
optional
stringSubnet stateACTIVE

Responses

NameDescriptionExample
idSubnet ID023c57b14f11483689338d085e061492
account_idAccount IDfnsd89fus0f9ds09f90dshf9dshfds09
cidrSubnet Cidr192.167.1.0/24
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
gateway_ip_addressGateway IP Address192.167.1.1
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSubnet NamesubnetName
stateSubnet stateACTIVE
typeSubnet TypePUBLIC
vpc_idVPC ID7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC namevpcName

2.1.15.3 - 1.1

scp-cli 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)

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

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
region
required
stringRegion to restore serverkr-west1
vpc_id
optional
stringVPC ID7df8abb4912e4709b1cb237daccca7a8
state
optional
stringSubnet stateACTIVE

Responses

NameDescriptionExample
idSubnet ID023c57b14f11483689338d085e061492
account_idAccount IDfnsd89fus0f9ds09f90dshf9dshfds09
cidrSubnet Cidr192.167.1.0/24
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
gateway_ip_addressGateway IP Address192.167.1.1
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSubnet NamesubnetName
stateSubnet stateACTIVE
typeSubnet TypePUBLIC
vpc_idVPC ID7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC namevpcName

2.1.15.4 - 1.0

scp-cli 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)

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

VersionNot Before
1.020260331

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
region
required
stringRegion to restore serverkr-west1
vpc_id
optional
stringVPC ID7df8abb4912e4709b1cb237daccca7a8
state
optional
stringSubnet stateACTIVE

Responses

NameDescriptionExample
idSubnet ID023c57b14f11483689338d085e061492
account_idAccount IDfnsd89fus0f9ds09f90dshf9dshfds09
cidrSubnet Cidr192.167.1.0/24
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
gateway_ip_addressGateway IP Address192.167.1.1
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSubnet NamesubnetName
stateSubnet stateACTIVE
typeSubnet TypePUBLIC
vpc_idVPC ID7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC namevpcName

2.1.16 - List Backup Restore Targets

2.1.16.1 - 1.3

scp-cli 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)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
backup_start_time
optional
stringStart time2024-09-30T15:00:00Z
backup_end_time
optional
stringEnd time2024-10-31T14:59:59Z
page
optional
integerPage0
size
optional
integerSize20
sort
optional
stringSortbackup_start_time:desc

Responses

NameDescriptionExample
backup_start_timeStart time2024-09-30T15:00:00Z
is_restore_availableWhether restore availabletrue
restore_target_idRestore target IDca1a8e76-af49-40ea-93f8-a5989ffe138b
retention_periodBackup retention periodWEEK_2
schedule_idSchedule IDf5b8e22b-0d88-4698-9996-fb44217c8227
schedule_nameSchedule nameINCREMENTAL_DAILY_15:00:00-chg4By
usage_gbBackup size(GB)123.4

2.1.16.2 - 1.2

scp-cli 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 (SUPPORTED)

VersionNot Before
1.220261231

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
backup_start_time
optional
stringStart time2024-09-30T15:00:00Z
backup_end_time
optional
stringEnd time2024-10-31T14:59:59Z
page
optional
integerPage0
size
optional
integerSize20
sort
optional
stringSortbackup_start_time:desc

Responses

NameDescriptionExample
backup_start_timeStart time2024-09-30T15:00:00Z
is_restore_availableWhether restore availabletrue
restore_target_idRestore target IDca1a8e76-af49-40ea-93f8-a5989ffe138b
retention_periodBackup retention periodWEEK_2
schedule_idSchedule IDf5b8e22b-0d88-4698-9996-fb44217c8227
schedule_nameSchedule nameINCREMENTAL_DAILY_15:00:00-chg4By
usage_gbBackup size(GB)123.4

2.1.16.3 - 1.1

scp-cli 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)

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

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
backup_start_time
optional
stringStart time2024-09-30T15:00:00Z
backup_end_time
optional
stringEnd time2024-10-31T14:59:59Z
page
optional
integerPage0
size
optional
integerSize20
sort
optional
stringSortbackup_start_time:desc

Responses

NameDescriptionExample
backup_start_timeStart time2024-09-30T15:00:00Z
is_restore_availableWhether restore availabletrue
restore_target_idRestore target IDca1a8e76-af49-40ea-93f8-a5989ffe138b
retention_periodBackup retention periodWEEK_2
schedule_idSchedule IDf5b8e22b-0d88-4698-9996-fb44217c8227
schedule_nameSchedule nameINCREMENTAL_DAILY_15:00:00-chg4By
usage_gbBackup size(GB)123.4

2.1.16.4 - 1.0

scp-cli 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)

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

VersionNot Before
1.020260331

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
backup_start_time
optional
stringStart time2024-09-30T15:00:00Z
backup_end_time
optional
stringEnd time2024-10-31T14:59:59Z
page
optional
integerPage0
size
optional
integerSize20
sort
optional
stringSortbackup_start_time:desc

Responses

NameDescriptionExample
backup_start_timeStart time2024-09-30T15:00:00Z
is_restore_availableWhether restore availabletrue
restore_target_idRestore target IDca1a8e76-af49-40ea-93f8-a5989ffe138b
retention_periodBackup retention periodWEEK_2
schedule_idSchedule IDf5b8e22b-0d88-4698-9996-fb44217c8227
schedule_nameSchedule nameINCREMENTAL_DAILY_15:00:00-chg4By
usage_gbBackup size(GB)123.4

2.1.17 - List Backup Schedules

2.1.17.1 - 1.3

scp-cli backup backup schedule list
--backup_id <value>

Description

List Backup schedules.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
backup_idBackup ID00cd2538fbf94d12b36aabbdd607e974
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
frequencySchedule frequency typeDAILY
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSchedule nameINCREMENTAL_DAILY_15:00:00-chg4By
start_daySchedule start dayMON
start_timeSchedule start time14:00:00
start_weekSchedule start weekWEEK_1
stateBackup Schedule stateAVAILABLE
typeSchedule typeFULL

2.1.17.2 - 1.2

scp-cli backup backup schedule list
--backup_id <value>

Description

List Backup schedules.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261231

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
backup_idBackup ID00cd2538fbf94d12b36aabbdd607e974
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
frequencySchedule frequency typeDAILY
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSchedule nameINCREMENTAL_DAILY_15:00:00-chg4By
start_daySchedule start dayMON
start_timeSchedule start time14:00:00
start_weekSchedule start weekWEEK_1
stateBackup Schedule stateAVAILABLE
typeSchedule typeFULL

2.1.17.3 - 1.1

scp-cli backup backup schedule list
--backup_id <value>

Description

List Backup schedules.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
backup_idBackup ID00cd2538fbf94d12b36aabbdd607e974
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
frequencySchedule frequency typeDAILY
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSchedule nameINCREMENTAL_DAILY_15:00:00-chg4By
start_daySchedule start dayMON
start_timeSchedule start time14:00:00
start_weekSchedule start weekWEEK_1
stateBackup Schedule stateAVAILABLE
typeSchedule typeFULL

2.1.17.4 - 1.0

scp-cli backup backup schedule list
--backup_id <value>

Description

List Backup schedules.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260331

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
backup_idBackup ID00cd2538fbf94d12b36aabbdd607e974
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
frequencySchedule frequency typeDAILY
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSchedule nameINCREMENTAL_DAILY_15:00:00-chg4By
start_daySchedule start dayMON
start_timeSchedule start time14:00:00
start_weekSchedule start weekWEEK_1
stateBackup Schedule stateAVAILABLE
typeSchedule typeFULL

2.1.18 - List Backup Targets

2.1.18.1 - 1.3

scp-cli backup backup target list
--policy_type <value>
--server_category <value>
[--server_name <value>]
[--region <value>]
[--page <value>]
[--size <value>]
[--zone <value>]

Description

List Backup targets.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
policy_type
required
****Backup policy typeVM_IMAGE
server_category
required
****Backup server category```VIRTUAL_SERVER
server_name
optional
stringBackup server nameserver-001
region
optional
stringRegionkr-west1
page
optional
integerPage0
size
optional
integerSize20
zone
optional
stringAvailability zone namekr-west1-a

Responses

NameDescriptionExample
server_guidBackup server GUID9ab33c66-3dbd-46cd-b0af-abccd3eb3170
server_nameBackup server nameserver-001
server_os_versionServer’s OS Type and VersionUBUNTU 22.04
server_typeBackup server types1v1m2
server_uuidBackup server UUID89f5ef44-1021-4a5c-8e06-fbb289eac366

2.1.18.2 - 1.2

scp-cli backup backup target list
--policy_type <value>
--server_category <value>
[--server_name <value>]
[--region <value>]
[--page <value>]
[--size <value>]

Description

List Backup targets.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261231

Parameters

NameTypeDescriptionExample
policy_type
required
****Backup policy typeVM_IMAGE
server_category
required
****Backup server category```VIRTUAL_SERVER
server_name
optional
stringBackup server nameserver-001
region
optional
stringRegionkr-west1
page
optional
integerPage0
size
optional
integerSize20

Responses

NameDescriptionExample
server_guidBackup server GUID9ab33c66-3dbd-46cd-b0af-abccd3eb3170
server_nameBackup server nameserver-001
server_os_versionServer’s OS Type and VersionUBUNTU 22.04
server_typeBackup server types1v1m2
server_uuidBackup server UUID89f5ef44-1021-4a5c-8e06-fbb289eac366

2.1.18.3 - 1.1

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

Description

List Backup targets.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
server_category
required
****Backup server category```VIRTUAL_SERVER
server_name
optional
stringBackup server nameserver-001
region
optional
stringRegionkr-west1
page
optional
integerPage0
size
optional
integerSize20

Responses

NameDescriptionExample
server_guidBackup server GUID9ab33c66-3dbd-46cd-b0af-abccd3eb3170
server_nameBackup server nameserver-001
server_os_versionServer’s OS Type and VersionUBUNTU 22.04
server_typeBackup server types1v1m2
server_uuidBackup server UUID89f5ef44-1021-4a5c-8e06-fbb289eac366

2.1.18.4 - 1.0

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

Description

List Backup targets.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260331

Parameters

NameTypeDescriptionExample
server_category
required
****Backup server category```VIRTUAL_SERVER
server_name
optional
stringBackup server nameserver-001
region
optional
stringRegionkr-west1
page
optional
integerPage0
size
optional
integerSize20

Responses

NameDescriptionExample
server_guidBackup server GUID9ab33c66-3dbd-46cd-b0af-abccd3eb3170
server_nameBackup server nameserver-001
server_os_versionServer’s OS Type and VersionUBUNTU 22.04
server_typeBackup server types1v1m2
server_uuidBackup server UUID89f5ef44-1021-4a5c-8e06-fbb289eac366

2.1.19 - List Backups

2.1.19.1 - 1.3

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

Description

List Backups.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringBackup namebackup-001
server_name
optional
stringBackup server nameserver-001

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameBackup namebackup-001
policy_typeBackup policy typeVM_IMAGE
retention_periodBackup retention periodWEEK_2
role_typeBackup role typeORIGINAL
server_nameBackup server nameserver-001
stateBackup stateAVAILABLE

2.1.19.2 - 1.2

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

Description

List Backups.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261231

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringBackup namebackup-001
server_name
optional
stringBackup server nameserver-001

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameBackup namebackup-001
policy_typeBackup policy typeVM_IMAGE
retention_periodBackup retention periodWEEK_2
role_typeBackup role typeORIGINAL
server_nameBackup server nameserver-001
stateBackup stateAVAILABLE

2.1.19.3 - 1.1

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

Description

List Backups.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringBackup namebackup-001
server_name
optional
stringBackup server nameserver-001

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameBackup namebackup-001
policy_typeBackup policy typeVM_IMAGE
retention_periodBackup retention periodWEEK_2
role_typeBackup role typeORIGINAL
server_nameBackup server nameserver-001
stateBackup stateAVAILABLE

2.1.19.4 - 1.0

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

Description

List Backups.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260331

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringBackup namebackup-001
server_name
optional
stringBackup server nameserver-001

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameBackup namebackup-001
policy_typeBackup policy typeVM_IMAGE
retention_periodBackup retention periodWEEK_2
role_typeBackup role typeORIGINAL
server_nameBackup server nameserver-001
stateBackup stateAVAILABLE

2.1.20 - List Filesystem Path

2.1.20.1 - 1.3

scp-cli backup backup agent filesystem path list
--backup_id <value>
--path <value>
--restore_target_id <value>

Description

List Filesystem path.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
path
required
stringList of filesystem backup path/
restore_target_id
required
stringRestore target IDca1a8e76-af49-40ea-93f8-a5989ffe138b

Responses

NameDescriptionExample
idFilesystem Path ID/data/_1768885200
item_typeFilesystem TypeDIR
nameFilesystem Namedata/
pathFilesystem Path/

2.1.20.2 - 1.2

scp-cli backup backup agent filesystem path list
--backup_id <value>
--path <value>
--restore_target_id <value>

Description

List Filesystem path.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261231

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
path
required
stringList of filesystem backup path/
restore_target_id
required
stringRestore target IDca1a8e76-af49-40ea-93f8-a5989ffe138b

Responses

NameDescriptionExample
idFilesystem Path ID/data/_1768885200
item_typeFilesystem TypeDIR
nameFilesystem Namedata/
pathFilesystem Path/

2.1.21 - List Targets of Backup Agent

2.1.21.1 - 1.3

scp-cli backup backup agent target list
--server_category <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--server_name <value>]
[--zone <value>]

Description

List targets of Backup Agent.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
server_category
required
stringBackup server categoryBAREMETAL_SERVER
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringSort-
server_name
optional
stringBackup server nameserver-001
zone
optional
stringAvailability zone namekr-west1-a

Responses

NameDescriptionExample
server_backup_agent_ipServer’s Backup Agent IP11.22.33.44
server_nameBackup Agent target server nameserver-001
server_stateBackup server stateRUNNING
server_typeBackup server types1v1m2
server_uuidBackup Agent target server UUID89f5ef44-1021-4a5c-8e06-fbb289eac366
vpc_idVPC ID7df8abb4912e4709b1cb237daccca7a8

2.1.21.2 - 1.2

scp-cli 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 (SUPPORTED)

VersionNot Before
1.220261231

Parameters

NameTypeDescriptionExample
server_category
required
stringBackup server categoryBAREMETAL_SERVER
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringSort-
server_name
optional
stringBackup server nameserver-001

Responses

NameDescriptionExample
server_backup_agent_ipServer’s Backup Agent IP11.22.33.44
server_nameBackup Agent target server nameserver-001
server_stateBackup server stateRUNNING
server_typeBackup server types1v1m2
server_uuidBackup Agent target server UUID89f5ef44-1021-4a5c-8e06-fbb289eac366
vpc_idVPC ID7df8abb4912e4709b1cb237daccca7a8

2.1.21.3 - 1.1

scp-cli 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)

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

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
server_category
required
stringBackup server categoryBAREMETAL_SERVER
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringSort-
server_name
optional
stringBackup server nameserver-001

Responses

NameDescriptionExample
server_backup_agent_ipServer’s Backup Agent IP11.22.33.44
server_nameBackup Agent target server nameserver-001
server_stateBackup server stateRUNNING
server_uuidBackup Agent target server UUID89f5ef44-1021-4a5c-8e06-fbb289eac366

2.1.21.4 - 1.0

scp-cli 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)

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

VersionNot Before
1.020260331

Parameters

NameTypeDescriptionExample
server_category
required
stringBackup server categoryBAREMETAL_SERVER
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringSort-
server_name
optional
stringBackup server nameserver-001

Responses

NameDescriptionExample
server_backup_agent_ipServer’s Backup Agent IP11.22.33.44
server_nameBackup Agent target server nameserver-001
server_stateBackup server stateRUNNING
server_uuidBackup Agent target server UUID89f5ef44-1021-4a5c-8e06-fbb289eac366

2.1.22 - Manual Backup

2.1.22.1 - 1.3

scp-cli backup backup manual backup create
--backup_id <value>

Description

Perform Manual Backup immediately.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974

Responses

NameDescriptionExample
request_idRequest ID
resourceResource

2.1.22.2 - 1.2

scp-cli backup backup manual backup create
--backup_id <value>

Description

Perform Manual Backup immediately.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261231

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974

Responses

NameDescriptionExample
request_idRequest ID
resourceResource

2.1.22.3 - 1.1

scp-cli backup backup manual backup create
--backup_id <value>

Description

Perform Manual Backup immediately.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974

Responses

NameDescriptionExample
request_idRequest ID
resourceResource

2.1.22.4 - 1.0

scp-cli backup backup manual backup create
--backup_id <value>

Description

Perform Manual Backup immediately.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260331

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974

Responses

NameDescriptionExample
request_idRequest ID
resourceResource

2.1.23 - Restore Agent Backup

2.1.23.1 - 1.3

scp-cli 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)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
restore_target_id
required
stringRestore target IDca1a8e76-af49-40ea-93f8-a5989ffe138b
restore_server_uuid
required
stringRestored server ID89f5ef44-1021-4a5c-8e06-fbb289eac366
filesystem_paths
required
arrayList of filesystem backup path'{"destination": "/", "source": "/"}'
overwrite
optional
booleanOverwriteTrue

Responses

NameDescriptionExample
request_idRequest ID
resourceResource

2.1.23.2 - 1.2

scp-cli 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 (SUPPORTED)

VersionNot Before
1.220261231

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
restore_target_id
required
stringRestore target IDca1a8e76-af49-40ea-93f8-a5989ffe138b
restore_server_uuid
required
stringRestored server ID89f5ef44-1021-4a5c-8e06-fbb289eac366
filesystem_paths
required
arrayList of filesystem backup path'{"destination": "/", "source": "/"}'
overwrite
optional
booleanOverwriteTrue

Responses

NameDescriptionExample
request_idRequest ID
resourceResource

2.1.23.3 - 1.1

scp-cli 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)

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

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
restore_target_id
required
stringRestore target IDca1a8e76-af49-40ea-93f8-a5989ffe138b
restore_server_uuid
required
stringRestored server ID89f5ef44-1021-4a5c-8e06-fbb289eac366
filesystem_paths
required
arrayList of filesystem backup path'{"destination": "/", "source": "/"}'
overwrite
optional
booleanOverwriteTrue

Responses

NameDescriptionExample
request_idRequest ID
resourceResource

2.1.23.4 - 1.0

scp-cli 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)

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

VersionNot Before
1.020260331

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
restore_target_id
required
stringRestore target IDca1a8e76-af49-40ea-93f8-a5989ffe138b
restore_server_uuid
required
stringRestored server ID89f5ef44-1021-4a5c-8e06-fbb289eac366
filesystem_paths
required
arrayList of filesystem backup path'{"destination": "/", "source": "/"}'
overwrite
optional
booleanOverwriteTrue

Responses

NameDescriptionExample
request_idRequest ID
resourceResource

2.1.24 - Restore Backup

2.1.24.1 - 1.3

scp-cli backup backup restore
--backup_id <value>
--server_type_id <value>
--restore_target_id <value>
--restore_server_name <value>
[--networks <value>]
[--restore_region <value>]
[--restore_zone <value>]
[--security_groups <value>]

Description

Restore the Backup.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
server_type_id
required
stringServer type ids1v1m2
restore_target_id
required
stringRestore target IDca1a8e76-af49-40ea-93f8-a5989ffe138b
restore_server_name
required
stringRestore server namerestoretest1
networks
optional
arrayNetwork info for restore'{"subnet_id": "023c57b14f11483689338d085e061492"}'
restore_region
optional
stringRegion to restore serverkr-west1
restore_zone
optional
stringAvailability zone namekr-west1-a
security_groups
optional
arraySecurity Group ID list023c57b14f11483689338d085e061492

Responses

NameDescriptionExample
request_idRequest ID
resourceResource

2.1.24.2 - 1.2

scp-cli 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 (SUPPORTED)

VersionNot Before
1.220261231

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
server_type_id
required
stringServer type ids1v1m2
restore_target_id
required
stringRestore target IDca1a8e76-af49-40ea-93f8-a5989ffe138b
restore_server_name
required
stringRestore server namerestoretest1
networks
optional
arrayNetwork info for restore'{"subnet_id": "023c57b14f11483689338d085e061492"}'
restore_region
optional
stringRegion to restore serverkr-west1
security_groups
optional
arraySecurity Group ID list023c57b14f11483689338d085e061492

Responses

NameDescriptionExample
request_idRequest ID
resourceResource

2.1.24.3 - 1.1

scp-cli 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)

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

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
server_type_id
required
stringServer type ids1v1m2
restore_target_id
required
stringRestore target IDca1a8e76-af49-40ea-93f8-a5989ffe138b
restore_server_name
required
stringRestore server namerestoretest1
networks
optional
arrayNetwork info for restore'{"subnet_id": "023c57b14f11483689338d085e061492"}'
restore_region
optional
stringRegion to restore serverkr-west1
security_groups
optional
arraySecurity Group ID list023c57b14f11483689338d085e061492

Responses

NameDescriptionExample
request_idRequest ID
resourceResource

2.1.24.4 - 1.0

scp-cli 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)

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

VersionNot Before
1.020260331

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
server_type_id
required
stringServer type ids1v1m2
restore_target_id
required
stringRestore target IDca1a8e76-af49-40ea-93f8-a5989ffe138b
restore_server_name
required
stringRestore server namerestoretest1
networks
optional
arrayNetwork info for restore'{"subnet_id": "023c57b14f11483689338d085e061492"}'
restore_region
optional
stringRegion to restore serverkr-west1
security_groups
optional
arraySecurity Group ID list023c57b14f11483689338d085e061492

Responses

NameDescriptionExample
request_idRequest ID
resourceResource

2.1.25 - Set Backup Schedule

2.1.25.1 - 1.3

scp-cli backup backup schedule set
--backup_id <value>
--schedules <value>

Description

Set Backup schedule.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
schedules
required
arrayBackup schedule list'{"frequency": "DAILY", "start_day": "MON", "start_time": "09:00:00", "start_week": "WEEK_2", "type": "FULL"}'

2.1.25.2 - 1.2

scp-cli backup backup schedule set
--backup_id <value>
--schedules <value>

Description

Set Backup schedule.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261231

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
schedules
required
arrayBackup schedule list'{"frequency": "DAILY", "start_day": "MON", "start_time": "09:00:00", "start_week": "WEEK_2", "type": "FULL"}'

2.1.25.3 - 1.1

scp-cli backup backup schedule set
--backup_id <value>
--schedules <value>

Description

Set Backup 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.

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
schedules
required
arrayBackup schedule list'{"frequency": "DAILY", "start_day": "MON", "start_time": "09:00:00", "start_week": "WEEK_2", "type": "FULL"}'

2.1.25.4 - 1.0

scp-cli backup backup schedule set
--backup_id <value>
--schedules <value>

Description

Set Backup 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.

VersionNot Before
1.020260331

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
schedules
required
arrayBackup schedule list'{"frequency": "DAILY", "start_day": "MON", "start_time": "09:00:00", "start_week": "WEEK_2", "type": "FULL"}'

2.1.26 - Set Filesystem Path

2.1.26.1 - 1.3

scp-cli backup backup agent filesystem path set
--backup_id <value>
[--backup_filesystem_paths <value>]
[--is_all_filesystem <value>]

Description

Set Filesystem path.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
backup_filesystem_paths
optional
arrayList of filesystem backup path/aaa
is_all_filesystem
optional
booleanWhether to target the all filesystemFalse

2.1.26.2 - 1.2

scp-cli backup backup agent filesystem path set
--backup_id <value>
[--backup_filesystem_paths <value>]
[--is_all_filesystem <value>]

Description

Set Filesystem path.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261231

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
backup_filesystem_paths
optional
arrayList of filesystem backup path/aaa
is_all_filesystem
optional
booleanWhether to target the all filesystemFalse

2.1.26.3 - 1.1

scp-cli backup backup agent filesystem path set
--backup_id <value>
--backup_filesystem_paths <value>

Description

Set Filesystem path.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
backup_filesystem_paths
required
arrayList of filesystem backup path/aaa

2.1.26.4 - 1.0

scp-cli backup backup agent filesystem path set
--backup_id <value>
--backup_filesystem_paths <value>

Description

Set Filesystem path.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260331

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
backup_filesystem_paths
required
arrayList of filesystem backup path/aaa

2.1.27 - Show Backup

2.1.27.1 - 1.3

scp-cli backup backup show
--backup_id <value>

Description

Show the detail of Backup.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
backup_agent_idBackup Agent IDBACKUP_AGENT-abcd
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
dr_enabledWhether to use DR
dr_regionDR Regionkr-west1
dr_zoneAvailability zone namekr-west1-a
encrypt_enabledWhether to use EncryptionFalse
filesystem_pathsList of filesystem backup path[’/aaa’, ‘/bbb’]
is_all_filesystemWhether to target the all filesystemFalse
is_server_deletedWhether the original server has been deleted
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameBackup namebackup-001
origin_backup_idBackup ID00cd2538fbf94d12b36aabbdd607e974
policy_categoryBackup policy categoryAGENTLESS
policy_typeBackup policy typeVM_IMAGE
regionRegionkr-west1
replica_backup_idBackup ID00cd2538fbf94d12b36aabbdd607e974
retention_periodBackup retention periodWEEK_2
role_typeBackup role typeORIGINAL
server_categoryBackup server categoryVIRTUAL_SERVER
server_nameBackup server nameserver-001
server_os_typeServer’s OS TypeWINDOWS
server_regionRegionkr-west1
server_uuidBackup server UUID89f5ef44-1021-4a5c-8e06-fbb289eac366
server_zoneAvailability zone namekr-west1-a
stateBackup stateAVAILABLE
zoneAvailability zone namekr-west1-a

2.1.27.2 - 1.2

scp-cli backup backup show
--backup_id <value>

Description

Show the detail of Backup.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261231

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
backup_agent_idBackup Agent IDBACKUP_AGENT-abcd
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
dr_enabledWhether to use DR
dr_regionDR Regionkr-west1
encrypt_enabledWhether to use EncryptionFalse
filesystem_pathsList of filesystem backup path[’/aaa’, ‘/bbb’]
is_all_filesystemWhether to target the all filesystemFalse
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameBackup namebackup-001
origin_backup_idBackup ID00cd2538fbf94d12b36aabbdd607e974
policy_categoryBackup policy categoryAGENTLESS
policy_typeBackup policy typeVM_IMAGE
regionRegionkr-west1
replica_backup_idBackup ID00cd2538fbf94d12b36aabbdd607e974
retention_periodBackup retention periodWEEK_2
role_typeBackup role typeORIGINAL
server_categoryBackup server categoryVIRTUAL_SERVER
server_nameBackup server nameserver-001
server_os_typeServer’s OS TypeWINDOWS
server_regionRegionkr-west1
server_uuidBackup server UUID89f5ef44-1021-4a5c-8e06-fbb289eac366
stateBackup stateAVAILABLE

2.1.27.3 - 1.1

scp-cli backup backup show
--backup_id <value>

Description

Show the detail of Backup.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
backup_agent_idBackup Agent IDBACKUP_AGENT-abcd
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
dr_enabledWhether to use DR
dr_regionDR Regionkr-west1
encrypt_enabledWhether to use EncryptionFalse
filesystem_pathsList of filesystem backup path[’/aaa’, ‘/bbb’]
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameBackup namebackup-001
origin_backup_idBackup ID00cd2538fbf94d12b36aabbdd607e974
policy_categoryBackup policy categoryAGENTLESS
policy_typeBackup policy typeVM_IMAGE
regionRegionkr-west1
replica_backup_idBackup ID00cd2538fbf94d12b36aabbdd607e974
retention_periodBackup retention periodWEEK_2
role_typeBackup role typeORIGINAL
server_categoryBackup server categoryVIRTUAL_SERVER
server_nameBackup server nameserver-001
server_os_typeServer’s OS TypeWINDOWS
server_regionRegionkr-west1
server_uuidBackup server UUID89f5ef44-1021-4a5c-8e06-fbb289eac366
stateBackup stateAVAILABLE

2.1.27.4 - 1.0

scp-cli backup backup show
--backup_id <value>

Description

Show the detail of Backup.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260331

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
backup_agent_idBackup Agent IDBACKUP_AGENT-abcd
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
encrypt_enabledWhether to use EncryptionFalse
filesystem_pathsList of filesystem backup path[’/aaa’, ‘/bbb’]
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameBackup namebackup-001
policy_categoryBackup policy categoryAGENTLESS
policy_typeBackup policy typeVM_IMAGE
regionRegionkr-west1
retention_periodBackup retention periodWEEK_2
role_typeBackup role typeORIGINAL
server_categoryBackup server categoryVIRTUAL_SERVER
server_nameBackup server nameserver-001
server_os_typeServer’s OS TypeWINDOWS
server_regionRegionkr-west1
server_uuidBackup server UUID89f5ef44-1021-4a5c-8e06-fbb289eac366
stateBackup stateAVAILABLE

2.1.28 - Show Backup Agent

2.1.28.1 - 1.3

scp-cli backup backup agent show
--backup_agent_id <value>

Description

Show the detail of Backup Agent.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
backup_agent_id
required
stringBackup Agent IDBACKUP_AGENT-abcd

Responses

NameDescriptionExample
idBackup Agent IDBACKUP_AGENT-abcd
account_idAccount IDfnsd89fus0f9ds09f90dshf9dshfds09
backup_master_ipBackup Master IP33.44.55.66
backup_master_nameBackup Master namebackupmastertest
backup_policy_countBackup policy count3
connection_check_timeBackup Agent connection check time2024-11-11T09:13:48Z
connection_stateBackup Agent connection stateSUCCESS
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
install_file_pathInstall file pathhttp://linux-agent
is_server_deletedWhether the original server has been deleted
media_serversBackup Agent Media Server list[]
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameBackup Agent Nameagent_abcd12
regionRegionkr-west1
server_backup_agent_ipServer’s Backup Agent IP11.22.33.44
server_categoryBackup server categoryVIRTUAL_SERVER
server_gateway_ipServer Gateway IP22.33.44.55
server_nameBackup Agent target server nameserver-001
server_os_typeServer’s OS TypeWINDOWS
server_uuidBackup Agent target server UUID89f5ef44-1021-4a5c-8e06-fbb289eac366
stateBackup Agent stateAVAILABLE
subnet_idSubnet ID
subnet_nameSubnet Name
zoneAvailability zone namekr-west1-a

2.1.28.2 - 1.2

scp-cli backup backup agent show
--backup_agent_id <value>

Description

Show the detail of Backup Agent.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261231

Parameters

NameTypeDescriptionExample
backup_agent_id
required
stringBackup Agent IDBACKUP_AGENT-abcd

Responses

NameDescriptionExample
idBackup Agent IDBACKUP_AGENT-abcd
account_idAccount IDfnsd89fus0f9ds09f90dshf9dshfds09
backup_master_ipBackup Master IP33.44.55.66
backup_master_nameBackup Master namebackupmastertest
backup_policy_countBackup policy count3
connection_check_timeBackup Agent connection check time2024-11-11T09:13:48Z
connection_stateBackup Agent connection stateSUCCESS
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
install_file_pathInstall file pathhttp://linux-agent
media_serversBackup Agent Media Server list[]
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameBackup Agent Nameagent_abcd12
server_backup_agent_ipServer’s Backup Agent IP11.22.33.44
server_categoryBackup server categoryVIRTUAL_SERVER
server_gateway_ipServer Gateway IP22.33.44.55
server_nameBackup Agent target server nameserver-001
server_os_typeServer’s OS TypeWINDOWS
server_uuidBackup Agent target server UUID89f5ef44-1021-4a5c-8e06-fbb289eac366
stateBackup Agent stateAVAILABLE
subnet_idSubnet ID
subnet_nameSubnet Name

2.1.28.3 - 1.1

scp-cli backup backup agent show
--backup_agent_id <value>

Description

Show the detail of Backup Agent.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
backup_agent_id
required
stringBackup Agent IDBACKUP_AGENT-abcd

Responses

NameDescriptionExample
idBackup Agent IDBACKUP_AGENT-abcd
account_idAccount IDfnsd89fus0f9ds09f90dshf9dshfds09
backup_master_ipBackup Master IP33.44.55.66
backup_master_nameBackup Master namebackupmastertest
backup_policy_countBackup policy count3
connection_check_timeBackup Agent connection check time2024-11-11T09:13:48Z
connection_stateBackup Agent connection stateSUCCESS
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
install_file_pathInstall file pathhttp://linux-agent
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameBackup Agent Nameagent_abcd12
server_backup_agent_ipServer’s Backup Agent IP11.22.33.44
server_categoryBackup server categoryVIRTUAL_SERVER
server_gateway_ipServer Gateway IP22.33.44.55
server_nameBackup Agent target server nameserver-001
server_os_typeServer’s OS TypeWINDOWS
server_uuidBackup Agent target server UUID89f5ef44-1021-4a5c-8e06-fbb289eac366
stateBackup Agent stateAVAILABLE

2.1.28.4 - 1.0

scp-cli backup backup agent show
--backup_agent_id <value>

Description

Show the detail of Backup Agent.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260331

Parameters

NameTypeDescriptionExample
backup_agent_id
required
stringBackup Agent IDBACKUP_AGENT-abcd

Responses

NameDescriptionExample
idBackup Agent IDBACKUP_AGENT-abcd
account_idAccount IDfnsd89fus0f9ds09f90dshf9dshfds09
backup_master_ipBackup Master IP33.44.55.66
backup_master_nameBackup Master namebackupmastertest
backup_policy_countBackup policy count3
connection_check_timeBackup Agent connection check time2024-11-11T09:13:48Z
connection_stateBackup Agent connection stateSUCCESS
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
install_file_pathInstall file pathhttp://linux-agent
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameBackup Agent Nameagent_abcd12
server_backup_agent_ipServer’s Backup Agent IP11.22.33.44
server_categoryBackup server categoryVIRTUAL_SERVER
server_gateway_ipServer Gateway IP22.33.44.55
server_nameBackup Agent target server nameserver-001
server_os_typeServer’s OS TypeWINDOWS
server_uuidBackup Agent target server UUID89f5ef44-1021-4a5c-8e06-fbb289eac366
stateBackup Agent stateAVAILABLE

2.1.29 - Show Backup Agent Install File Path

2.1.29.1 - 1.3

scp-cli backup backup agent install file path show
--os_type <value>

Description

Show Backup Agent Install File Path.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
os_type
required
stringOS type-

Responses

NameDescriptionExample
install_file_pathInstall file pathhttp://linux-agent

2.1.29.2 - 1.2

scp-cli backup backup agent install file path show
--os_type <value>

Description

Show Backup Agent Install File Path.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261231

Parameters

NameTypeDescriptionExample
os_type
required
stringOS type-

Responses

NameDescriptionExample
install_file_pathInstall file pathhttp://linux-agent

2.1.29.3 - 1.1

scp-cli backup backup agent install file path show
--os_type <value>

Description

Show Backup Agent Install File Path.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
os_type
required
stringOS type-

Responses

NameDescriptionExample
install_file_pathInstall file pathhttp://linux-agent

2.1.29.4 - 1.0

scp-cli backup backup agent install file path show
--os_type <value>

Description

Show Backup Agent Install File Path.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260331

Parameters

NameTypeDescriptionExample
os_type
required
stringOS type-

Responses

NameDescriptionExample
install_file_pathInstall file pathhttp://linux-agent

2.1.30 - Update Replication Use

2.1.30.1 - 1.3

scp-cli backup backup replication use set
--backup_id <value>
--dr_enabled <value>

Description

Update Replication use.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
dr_enabled
required
booleanWhether to use DRFalse

2.1.30.2 - 1.2

scp-cli backup backup replication use set
--backup_id <value>
--dr_enabled <value>

Description

Update Replication use.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261231

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
dr_enabled
required
booleanWhether to use DRFalse

2.1.30.3 - 1.1

scp-cli backup backup replication use set
--backup_id <value>
--dr_enabled <value>

Description

Update Replication use.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
dr_enabled
required
booleanWhether to use DRFalse

2.1.30.4 - 1.0

scp-cli backup backup replication use set
--backup_id <value>
--dr_enabled <value>

Description

Update Replication use.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260331

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
dr_enabled
required
booleanWhether to use DRFalse

2.1.31 - Update Retention Period

2.1.31.1 - 1.3

scp-cli backup backup retention period set
--backup_id <value>
--retention_period <value>

Description

Update the retention period.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
retention_period
required
stringBackup retention periodWEEK_2

2.1.31.2 - 1.2

scp-cli backup backup retention period set
--backup_id <value>
--retention_period <value>

Description

Update the retention period.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220261231

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
retention_period
required
stringBackup retention periodWEEK_2

2.1.31.3 - 1.1

scp-cli backup backup retention period set
--backup_id <value>
--retention_period <value>

Description

Update the retention period.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.120260531

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
retention_period
required
stringBackup retention periodWEEK_2

2.1.31.4 - 1.0

scp-cli backup backup retention period set
--backup_id <value>
--retention_period <value>

Description

Update the retention period.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020260331

Parameters

NameTypeDescriptionExample
backup_id
required
stringBackup ID00cd2538fbf94d12b36aabbdd607e974
retention_period
required
stringBackup retention periodWEEK_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

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

VersionStatusNot Before
1.4CURRENT-
1.3SUPPORTED20270131
1.2DEPRECATED20260531
1.1DEPRECATED20260331
1.0DEPRECATED20251231

CLI Version History

1.4

Multi AZ feature has been added.

Changes

  • [Updated] volume create Create Volume zone field has been added to the request.
  • [Updated] volume-group create Create Volume Group zone field has been added to the request.
  • [Updated] volume-group replication create Create Volume Group Replication zone field has been added to the request.
  • [Updated] volume replication create Create Volume Replication zone field has been added to the request.
  • [Updated] volume-group list List Volume Groups zone field has been added to the response.
  • [Updated] volume list List Volumes zone field has been added to the response.
  • [Updated] volume show Show Volume zone field has been added to the response.
  • [Updated] volume-group show Show Volume Group zone field has been added to the response.
  • [Updated] volume-group replication show Show Volume Group Replication zone field has been added to the response.
  • [Updated] volume replication show Show Volume Replication zone field has been added to the response.

1.3

Replica Lag time retrieval have been added.

Changes

  • [Updated] volume replication show Lag time has been added to the response.
  • [Updated] volume-group replication show Lag time has been added to the response.

1.2

QoS configuration feature has been added.

Changes

  • [New] volume qos set Set Volume QoS command has been added.
  • [Updated] volume create QoS item has been added as a required input.
  • [Updated] volume show QoS item has been added to the response.

1.1

Recovery creation feature has been added.

Changes

  • [New] volume-group recovery create Create Volume Group Recovery command has been added.
  • [New] volume recovery create Create Volume Recovery command has been added.

1.0

Block Storage(BM) has been released.

Changes

  • [New] volume group member add Add Volume Group Member on Volume Group command has been added.
  • [New] volume create Create Volume command has been added.
  • [New] volume attachment create Create Volume Attachments command has been added.
  • [New] volume-group create Create Volume Group command has been added.
  • [New] volume-group replication create Create Volume Group Replication command has been added.
  • [New] volume-group snapshot create Create Volume Group Snapshot command has been added.
  • [New] volume-group snapshot-schedule create Create Volume Group Snapshot Schedule command has been added.
  • [New] volume replication create Create Volume Replication command has been added.
  • [New] volume snapshot create Create Volume Snapshot command has been added.
  • [New] volume snapshot-rate create Create Volume Snapshot Rate command has been added.
  • [New] volume snapshot-schedule create Create Volume Snapshot Schedule command has been added.
  • [New] volume delete Delete Volume command has been added.
  • [New] volume attachment delete Delete Volume Attachments command has been added.
  • [New] volume-group replication delete Delete Volume Group Replication command has been added.
  • [New] volume-group snapshot delete Delete Volume Group Snapshot command has been added.
  • [New] volume-group snapshot-schedule delete Delete Volume Group Snapshot Schedule command has been added.
  • [New] volume replication delete Delete Volume Replication command has been added.
  • [New] volume snapshot delete Delete Volume Snapshot command has been added.
  • [New] volume snapshot-rate delete Delete Volume Snapshot Rate command has been added.
  • [New] volume snapshot-schedule delete Delete Volume Snapshot Schedule command has been added.
  • [New] volume-group snapshot list List Volume Group Snapshots command has been added.
  • [New] volume-group list List Volume Groups command has been added.
  • [New] volume snapshot list List Volume Snapshots command has been added.
  • [New] volume list List Volumes command has been added.
  • [New] volume-group member remove Remove Volume Group Member on Volume Group command has been added.
  • [New] volume-group snapshot restore Restore Volume Group Snapshot command has been added.
  • [New] volume snapshot restore Restore Volume Snapshot command has been added.
  • [New] volume-group replication-cycle set Set Volume Group Replication Cycle command has been added.
  • [New] volume-group replication-policy set Set Volume Group Replication Policy command has been added.
  • [New] volume-group snapshot-schedule set Set Volume Group Snapshot Schedule command has been added.
  • [New] volume replication-cycle set Set Volume Replication Cycle command has been added.
  • [New] volume replication-policy set Set Volume Replication Policy command has been added.
  • [New] volume snapshot-rate set Set Volume Snapshot Rate command has been added.
  • [New] volume snapshot-schedule set Set Volume Snapshot Schedule command has been added.
  • [New] volume show Show Volume command has been added.
  • [New] volume-group show Show Volume Group command has been added.
  • [New] volume-group replication show Show Volume Group Replication command has been added.
  • [New] volume replication show Show Volume Replication command has been added.

3.1 - CLIs

3.1.1 - Add Volume Group Member on Volume Group

3.1.1.1 - 1.4

scp-cli baremetal-blockstorage volume-group member add
--volume_group_id <value>
--volume_ids <value>

Description

Add Volume Group Member on Volume Group.

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063
volume_ids
required
arrayList of volume(Block Storage) id13666d6c32d4456e8421f7768d0bf225

3.1.1.2 - 1.3

scp-cli baremetal-blockstorage volume-group member add
--volume_group_id <value>
--volume_ids <value>

Description

Add Volume Group Member on Volume Group.

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063
volume_ids
required
arrayList of volume(Block Storage) id13666d6c32d4456e8421f7768d0bf225

3.1.1.3 - 1.2

scp-cli baremetal-blockstorage volume-group member add
--volume_group_id <value>
--volume_ids <value>

Description

Add Volume Group Member on Volume Group.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.220260531

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063
volume_ids
required
arrayList of volume(Block Storage) id13666d6c32d4456e8421f7768d0bf225

3.1.1.4 - 1.1

scp-cli baremetal-blockstorage volume-group member add
--volume_group_id <value>
--volume_ids <value>

Description

Add Volume Group Member on Volume Group.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.120260331

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063
volume_ids
required
arrayList of volume(Block Storage) id13666d6c32d4456e8421f7768d0bf225

3.1.1.5 - 1.0

scp-cli baremetal-blockstorage volume-group member add
--volume_group_id <value>
--volume_ids <value>

Description

Add Volume Group Member on Volume Group.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063
volume_ids
required
arrayList of volume(Block Storage) id13666d6c32d4456e8421f7768d0bf225

3.1.2 - Attach Volume

3.1.2.1 - 1.4

scp-cli baremetal-blockstorage volume attachment create
--volume_id <value>
--attachments <value>

Description

Attach Volume to servers.

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
attachments
required
arrayList of server id and type'{"object_id": "83c3c73d457345e3829ee6d5557c0016", "object_type": "BM"}'

Responses

NameDescriptionExample
object_idObject id83c3c73d457345e3829ee6d5557c0016
object_typeObject type

3.1.2.2 - 1.3

scp-cli baremetal-blockstorage volume attachment create
--volume_id <value>
--attachments <value>

Description

Attach Volume to servers.

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
attachments
required
arrayList of server id and type'{"object_id": "83c3c73d457345e3829ee6d5557c0016", "object_type": "BM"}'

Responses

NameDescriptionExample
object_idObject id83c3c73d457345e3829ee6d5557c0016
object_typeObject type

3.1.2.3 - 1.2

scp-cli baremetal-blockstorage volume attachment create
--volume_id <value>
--attachments <value>

Description

Attach Volume to servers.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.220260531

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
attachments
required
arrayList of server id and type'{"object_id": "83c3c73d457345e3829ee6d5557c0016", "object_type": "BM"}'

Responses

NameDescriptionExample
object_idObject id83c3c73d457345e3829ee6d5557c0016
object_typeObject type

3.1.2.4 - 1.1

scp-cli baremetal-blockstorage volume attachment create
--volume_id <value>
--attachments <value>

Description

Attach Volume to servers.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.120260331

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
attachments
required
arrayList of server id and type'{"object_id": "83c3c73d457345e3829ee6d5557c0016", "object_type": "BM"}'

Responses

NameDescriptionExample
resultVolume detail

3.1.2.5 - 1.0

scp-cli baremetal-blockstorage volume attachment create
--volume_id <value>
--attachments <value>

Description

Attach Volume to servers.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
attachments
required
arrayList of server id and type'{"object_id": "83c3c73d457345e3829ee6d5557c0016", "object_type": "BM"}'

Responses

NameDescriptionExample
resultVolume detail

3.1.3 - Create Volume

3.1.3.1 - 1.4

scp-cli baremetal-blockstorage volume create
--throughput <value>
--iops <value>
--zone <value>
--size_gb <value>
--name <value>
--disk_type <value>
--attachments <value>
[--tags <value>]

Description

Create Volume.

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
throughput
required
integerEnter the value between at least 250MB/s and up to 1,000MB/s.250
iops
required
integerEnter the value between at least 5,000 IOPS and up to 20,000 IOPS.5000
zone
required
stringAvailability zonekr-west1-a
size_gb
required
integerVolume capacity(GB)10
name
required
stringVolume namebs-01
disk_type
required
stringDisk type-
attachments
required
arrayList of server id and type'{"object_id": "83c3c73d457345e3829ee6d5557c0016", "object_type": "BM"}'
tags
optional
arrayTags'{"key": "my_tag_1", "value": "my_value_1"}'

Responses

NameDescriptionExample
request_idRequest idreq-0006064c-c008-458c-8977-19671c6b32d4
resource_idResource id8bf55e738d4e44b5a21dbe133a42ecbe

3.1.3.2 - 1.3

scp-cli 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 (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
throughput
required
integerEnter the value between at least 250MB/s and up to 1,000MB/s.250
iops
required
integerEnter the value between at least 5,000 IOPS and up to 20,000 IOPS.5000
size_gb
required
integerVolume capacity(GB)10
name
required
stringVolume namebs-01
disk_type
required
stringDisk type-
attachments
required
arrayList of server id and type'{"object_id": "83c3c73d457345e3829ee6d5557c0016", "object_type": "BM"}'
tags
optional
arrayTags'{"key": "my_tag_1", "value": "my_value_1"}'

Responses

NameDescriptionExample
request_idRequest idreq-0006064c-c008-458c-8977-19671c6b32d4
resource_idResource id8bf55e738d4e44b5a21dbe133a42ecbe

3.1.3.3 - 1.2

scp-cli baremetal-blockstorage volume create
--throughput <value>
--iops <value>
--size_gb <value>
--name <value>
--disk_type <value>
--attachments <value>
[--tags <value>]

Description

Create Volume.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.220260531

Parameters

NameTypeDescriptionExample
throughput
required
integerEnter the value between at least 250MB/s and up to 1,000MB/s.250
iops
required
integerEnter the value between at least 5,000 IOPS and up to 20,000 IOPS.5000
size_gb
required
integerVolume capacity(GB)10
name
required
stringVolume namebs-01
disk_type
required
stringDisk type-
attachments
required
arrayList of server id and type'{"object_id": "83c3c73d457345e3829ee6d5557c0016", "object_type": "BM"}'
tags
optional
arrayTags'{"key": "my_tag_1", "value": "my_value_1"}'

Responses

NameDescriptionExample
request_idRequest idreq-0006064c-c008-458c-8977-19671c6b32d4
resource_idResource id8bf55e738d4e44b5a21dbe133a42ecbe

3.1.3.4 - 1.1

scp-cli baremetal-blockstorage volume create
--size_gb <value>
--name <value>
--disk_type <value>
--attachments <value>
[--tags <value>]

Description

Create Volume.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.120260331

Parameters

NameTypeDescriptionExample
size_gb
required
integerVolume capacity(GB)10
name
required
stringVolume namebs-01
disk_type
required
stringDisk type-
attachments
required
arrayList of server id and type'{"object_id": "83c3c73d457345e3829ee6d5557c0016", "object_type": "BM"}'
tags
optional
arrayTags'{"key": "my_tag_1", "value": "my_value_1"}'

Responses

NameDescriptionExample
request_idRequest idreq-0006064c-c008-458c-8977-19671c6b32d4
resource_idResource id8bf55e738d4e44b5a21dbe133a42ecbe

3.1.3.5 - 1.0

scp-cli baremetal-blockstorage volume create
--size_gb <value>
--name <value>
--disk_type <value>
--attachments <value>
[--tags <value>]

Description

Create Volume.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
size_gb
required
integerVolume capacity(GB)10
name
required
stringVolume namebs-01
disk_type
required
stringDisk type-
attachments
required
arrayList of server id and type'{"object_id": "83c3c73d457345e3829ee6d5557c0016", "object_type": "BM"}'
tags
optional
arrayTags'{"key": "my_tag_1", "value": "my_value_1"}'

Responses

NameDescriptionExample
request_idRequest idreq-0006064c-c008-458c-8977-19671c6b32d4
resource_idResource id8bf55e738d4e44b5a21dbe133a42ecbe

3.1.4 - Create Volume Group

3.1.4.1 - 1.4

scp-cli baremetal-blockstorage volume-group create
--zone <value>
--volume_ids <value>
--name <value>
[--tags <value>]

Description

Create Volume Group

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
zone
required
stringAvailability zonekr-west1-a
volume_ids
required
arrayList of volume(Block Storage) id to add17e0b4fd27784dfb843440ec08bdd148
name
required
stringVolume group namevg-01
tags
optional
arrayTags'{"key": "my_tag_1", "value": "my_value_1"}'

Responses

NameDescriptionExample
request_idRequest idreq-0006064c-c008-458c-8977-19671c6b32d4
resource_idResource id8bf55e738d4e44b5a21dbe133a42ecbe

3.1.4.2 - 1.3

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

Description

Create Volume Group

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
volume_ids
required
arrayList of volume(Block Storage) id to add17e0b4fd27784dfb843440ec08bdd148
name
required
stringVolume group namevg-01
tags
optional
arrayTags'{"key": "my_tag_1", "value": "my_value_1"}'

Responses

NameDescriptionExample
request_idRequest idreq-0006064c-c008-458c-8977-19671c6b32d4
resource_idResource id8bf55e738d4e44b5a21dbe133a42ecbe

3.1.4.3 - 1.2

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

Description

Create Volume Group

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.220260531

Parameters

NameTypeDescriptionExample
volume_ids
required
arrayList of volume(Block Storage) id to add17e0b4fd27784dfb843440ec08bdd148
name
required
stringVolume group namevg-01
tags
optional
arrayTags'{"key": "my_tag_1", "value": "my_value_1"}'

Responses

NameDescriptionExample
request_idRequest idreq-0006064c-c008-458c-8977-19671c6b32d4
resource_idResource id8bf55e738d4e44b5a21dbe133a42ecbe

3.1.4.4 - 1.1

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

Description

Create Volume Group

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.120260331

Parameters

NameTypeDescriptionExample
volume_ids
required
arrayList of volume(Block Storage) id to add17e0b4fd27784dfb843440ec08bdd148
name
required
stringVolume group namevg-01
tags
optional
arrayTags'{"key": "my_tag_1", "value": "my_value_1"}'

Responses

NameDescriptionExample
request_idRequest idreq-0006064c-c008-458c-8977-19671c6b32d4
resource_idResource id8bf55e738d4e44b5a21dbe133a42ecbe

3.1.4.5 - 1.0

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

Description

Create Volume Group

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
volume_ids
required
arrayList of volume(Block Storage) id to add17e0b4fd27784dfb843440ec08bdd148
name
required
stringVolume group namevg-01
tags
optional
arrayTags'{"key": "my_tag_1", "value": "my_value_1"}'

Responses

NameDescriptionExample
request_idRequest idreq-0006064c-c008-458c-8977-19671c6b32d4
resource_idResource id8bf55e738d4e44b5a21dbe133a42ecbe

3.1.5 - Create Volume Group Recovery

3.1.5.1 - 1.4

scp-cli 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)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063
snapshot_id
required
stringSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
block_storage_name_prefix
required
stringBlock Storage name prefixprefix-

Responses

NameDescriptionExample
request_idRequest idreq-0006064c-c008-458c-8977-19671c6b32d4
resource_idResource id8bf55e738d4e44b5a21dbe133a42ecbe

3.1.5.2 - 1.3

scp-cli 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 (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063
snapshot_id
required
stringSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
block_storage_name_prefix
required
stringBlock Storage name prefixprefix-

Responses

NameDescriptionExample
request_idRequest idreq-0006064c-c008-458c-8977-19671c6b32d4
resource_idResource id8bf55e738d4e44b5a21dbe133a42ecbe

3.1.5.3 - 1.2

scp-cli baremetal-blockstorage volume-group recovery create
--volume_group_id <value>
--snapshot_id <value>
--block_storage_name_prefix <value>

Description

Create Volume Group Recovery.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.220260531

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063
snapshot_id
required
stringSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
block_storage_name_prefix
required
stringBlock Storage name prefixprefix-

Responses

NameDescriptionExample
request_idRequest idreq-0006064c-c008-458c-8977-19671c6b32d4
resource_idResource id8bf55e738d4e44b5a21dbe133a42ecbe

3.1.5.4 - 1.1

scp-cli baremetal-blockstorage volume-group recovery create
--volume_group_id <value>
--snapshot_id <value>
--block_storage_name_prefix <value>

Description

Create Volume Group Recovery.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.120260331

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063
snapshot_id
required
stringSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
block_storage_name_prefix
required
stringBlock Storage name prefixprefix-

Responses

NameDescriptionExample
request_idRequest idreq-0006064c-c008-458c-8977-19671c6b32d4
resource_idResource id8bf55e738d4e44b5a21dbe133a42ecbe

3.1.6 - Create Volume Group Replication

3.1.6.1 - 1.4

scp-cli baremetal-blockstorage volume-group replication create
--volume_group_id <value>
--zone <value>
--replication_volume_name_prefix <value>
--region <value>
--name <value>
--cycle <value>

Description

Create Volume Group Replication.

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063
zone
required
stringAvailability zonekr-west1-a
replication_volume_name_prefix
required
stringReplication volume name prefixdr
region
required
stringRegionkr-west1
name
required
stringReplication volume group namereplica-vg-01
cycle
required
stringReplication cycle-

Responses

NameDescriptionExample
request_idRequest idreq-0006064c-c008-458c-8977-19671c6b32d4
resource_idResource id8bf55e738d4e44b5a21dbe133a42ecbe

3.1.6.2 - 1.3

scp-cli 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 (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063
replication_volume_name_prefix
required
stringReplication volume name prefixdr
region
required
stringRegionkr-west1
name
required
stringReplication volume group namereplica-vg-01
cycle
required
stringReplication cycle-

Responses

NameDescriptionExample
request_idRequest idreq-0006064c-c008-458c-8977-19671c6b32d4
resource_idResource id8bf55e738d4e44b5a21dbe133a42ecbe

3.1.6.3 - 1.2

scp-cli baremetal-blockstorage volume-group replication create
--volume_group_id <value>
--replication_volume_name_prefix <value>
--region <value>
--name <value>
--cycle <value>

Description

Create Volume Group Replication.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.220260531

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063
replication_volume_name_prefix
required
stringReplication volume name prefixdr
region
required
stringRegionkr-west1
name
required
stringReplication volume group namereplica-vg-01
cycle
required
stringReplication cycle-

Responses

NameDescriptionExample
request_idRequest idreq-0006064c-c008-458c-8977-19671c6b32d4
resource_idResource id8bf55e738d4e44b5a21dbe133a42ecbe

3.1.6.4 - 1.1

scp-cli baremetal-blockstorage volume-group replication create
--volume_group_id <value>
--replication_volume_name_prefix <value>
--region <value>
--name <value>
--cycle <value>

Description

Create Volume Group Replication.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.120260331

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063
replication_volume_name_prefix
required
stringReplication volume name prefixdr
region
required
stringRegionkr-west1
name
required
stringReplication volume group namereplica-vg-01
cycle
required
stringReplication cycle-

Responses

NameDescriptionExample
request_idRequest idreq-0006064c-c008-458c-8977-19671c6b32d4
resource_idResource id8bf55e738d4e44b5a21dbe133a42ecbe

3.1.6.5 - 1.0

scp-cli baremetal-blockstorage volume-group replication create
--volume_group_id <value>
--replication_volume_name_prefix <value>
--region <value>
--name <value>
--cycle <value>

Description

Create Volume Group Replication.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063
replication_volume_name_prefix
required
stringReplication volume name prefixdr
region
required
stringRegionkr-west1
name
required
stringReplication volume group namereplica-vg-01
cycle
required
stringReplication cycle-

Responses

NameDescriptionExample
request_idRequest idreq-0006064c-c008-458c-8977-19671c6b32d4
resource_idResource id8bf55e738d4e44b5a21dbe133a42ecbe

3.1.7 - Create Volume Group Snapshot

3.1.7.1 - 1.4

scp-cli baremetal-blockstorage volume-group snapshot create
--volume_group_id <value>

Description

Create Volume Group Snapshot

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063

Responses

NameDescriptionExample
account_idAccount id36827d9b643f46c2ae6bb7e63d633bfe
snapshot_idSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
snapshot_nameSnapshot namevo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932
volume_group_idVolume group idc9ecae8b973b425c81c3817893cd8063

3.1.7.2 - 1.3

scp-cli baremetal-blockstorage volume-group snapshot create
--volume_group_id <value>

Description

Create Volume Group Snapshot

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063

Responses

NameDescriptionExample
account_idAccount id36827d9b643f46c2ae6bb7e63d633bfe
snapshot_idSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
snapshot_nameSnapshot namevo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932
volume_group_idVolume group idc9ecae8b973b425c81c3817893cd8063

3.1.7.3 - 1.2

scp-cli baremetal-blockstorage volume-group snapshot create
--volume_group_id <value>

Description

Create Volume Group Snapshot

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.220260531

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063

Responses

NameDescriptionExample
account_idAccount id36827d9b643f46c2ae6bb7e63d633bfe
snapshot_idSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
snapshot_nameSnapshot namevo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932
volume_group_idVolume group idc9ecae8b973b425c81c3817893cd8063

3.1.7.4 - 1.1

scp-cli baremetal-blockstorage volume-group snapshot create
--volume_group_id <value>

Description

Create Volume Group Snapshot

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.120260331

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063

Responses

NameDescriptionExample
account_idAccount id36827d9b643f46c2ae6bb7e63d633bfe
snapshot_idSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
snapshot_nameSnapshot namevo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932
volume_group_idVolume group idc9ecae8b973b425c81c3817893cd8063

3.1.7.5 - 1.0

scp-cli baremetal-blockstorage volume-group snapshot create
--volume_group_id <value>

Description

Create Volume Group Snapshot

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063

Responses

NameDescriptionExample
account_idAccount id36827d9b643f46c2ae6bb7e63d633bfe
snapshot_idSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
snapshot_nameSnapshot namevo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932
volume_group_idVolume group idc9ecae8b973b425c81c3817893cd8063

3.1.8 - Create Volume Group Snapshot Schedule

3.1.8.1 - 1.4

scp-cli 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)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063
hour
required
integerHour18
day_of_week
optional
stringDay of week(If this field is excluded, the schedule frequency is set to DAILY.)-

Responses

NameDescriptionExample
day_of_weekDay of week
frequencyFrequency DAILYWEEKLY
hourHour18
volume_group_idVolume group idc9ecae8b973b425c81c3817893cd8063

3.1.8.2 - 1.3

scp-cli 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 (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063
hour
required
integerHour18
day_of_week
optional
stringDay of week(If this field is excluded, the schedule frequency is set to DAILY.)-

Responses

NameDescriptionExample
day_of_weekDay of week
frequencyFrequency DAILYWEEKLY
hourHour18
volume_group_idVolume group idc9ecae8b973b425c81c3817893cd8063

3.1.8.3 - 1.2

scp-cli baremetal-blockstorage volume-group snapshot-schedule create
--volume_group_id <value>
--hour <value>
[--day_of_week <value>]

Description

Create Volume Group Snapshot Schedule.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.220260531

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063
hour
required
integerHour18
day_of_week
optional
stringDay of week(If this field is excluded, the schedule frequency is set to DAILY.)-

Responses

NameDescriptionExample
day_of_weekDay of week
frequencyFrequency DAILYWEEKLY
hourHour18
volume_group_idVolume group idc9ecae8b973b425c81c3817893cd8063

3.1.8.4 - 1.1

scp-cli baremetal-blockstorage volume-group snapshot-schedule create
--volume_group_id <value>
--hour <value>
[--day_of_week <value>]

Description

Create Volume Group Snapshot Schedule.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.120260331

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063
hour
required
integerHour18
day_of_week
optional
stringDay of week(If this field is excluded, the schedule frequency is set to DAILY.)-

Responses

NameDescriptionExample
day_of_weekDay of week
frequencyFrequency DAILYWEEKLY
hourHour18
volume_group_idVolume group idc9ecae8b973b425c81c3817893cd8063

3.1.8.5 - 1.0

scp-cli baremetal-blockstorage volume-group snapshot-schedule create
--volume_group_id <value>
--hour <value>
[--day_of_week <value>]

Description

Create Volume Group Snapshot Schedule.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063
hour
required
integerHour18
day_of_week
optional
stringDay of week(If this field is excluded, the schedule frequency is set to DAILY.)-

Responses

NameDescriptionExample
day_of_weekDay of week
frequencyFrequency DAILYWEEKLY
hourHour18
volume_group_idVolume group idc9ecae8b973b425c81c3817893cd8063

3.1.9 - Create Volume Recovery

3.1.9.1 - 1.4

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

Description

Create Volume Recovery.

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
snapshot_id
required
stringSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
name
required
stringRecovery volume namerecovery-volume

Responses

NameDescriptionExample
request_idRequest idreq-0006064c-c008-458c-8977-19671c6b32d4
resource_idResource id8bf55e738d4e44b5a21dbe133a42ecbe

3.1.9.2 - 1.3

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

Description

Create Volume Recovery.

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
snapshot_id
required
stringSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
name
required
stringRecovery volume namerecovery-volume

Responses

NameDescriptionExample
request_idRequest idreq-0006064c-c008-458c-8977-19671c6b32d4
resource_idResource id8bf55e738d4e44b5a21dbe133a42ecbe

3.1.9.3 - 1.2

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

Description

Create Volume Recovery.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.220260531

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
snapshot_id
required
stringSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
name
required
stringRecovery volume namerecovery-volume

Responses

NameDescriptionExample
request_idRequest idreq-0006064c-c008-458c-8977-19671c6b32d4
resource_idResource id8bf55e738d4e44b5a21dbe133a42ecbe

3.1.9.4 - 1.1

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

Description

Create Volume Recovery.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.120260331

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
snapshot_id
required
stringSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
name
required
stringRecovery volume namerecovery-volume

Responses

NameDescriptionExample
request_idRequest idreq-0006064c-c008-458c-8977-19671c6b32d4
resource_idResource id8bf55e738d4e44b5a21dbe133a42ecbe

3.1.10 - Create Volume Replication

3.1.10.1 - 1.4

scp-cli baremetal-blockstorage volume replication create
--volume_id <value>
--zone <value>
--region <value>
--name <value>
--cycle <value>

Description

Create Volume Replication.

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
zone
required
stringAvailability zonekr-west1-a
region
required
stringRegionkr-west1
name
required
stringReplication volume namereplica-bs-01
cycle
required
stringReplication cycle-

Responses

NameDescriptionExample
request_idRequest idreq-0006064c-c008-458c-8977-19671c6b32d4
resource_idResource id8bf55e738d4e44b5a21dbe133a42ecbe

3.1.10.2 - 1.3

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

Description

Create Volume Replication.

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
region
required
stringRegionkr-west1
name
required
stringReplication volume namereplica-bs-01
cycle
required
stringReplication cycle-

Responses

NameDescriptionExample
request_idRequest idreq-0006064c-c008-458c-8977-19671c6b32d4
resource_idResource id8bf55e738d4e44b5a21dbe133a42ecbe

3.1.10.3 - 1.2

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

Description

Create Volume Replication.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.220260531

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
region
required
stringRegionkr-west1
name
required
stringReplication volume namereplica-bs-01
cycle
required
stringReplication cycle-

Responses

NameDescriptionExample
request_idRequest idreq-0006064c-c008-458c-8977-19671c6b32d4
resource_idResource id8bf55e738d4e44b5a21dbe133a42ecbe

3.1.10.4 - 1.1

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

Description

Create Volume Replication.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.120260331

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
region
required
stringRegionkr-west1
name
required
stringReplication volume namereplica-bs-01
cycle
required
stringReplication cycle-

Responses

NameDescriptionExample
request_idRequest idreq-0006064c-c008-458c-8977-19671c6b32d4
resource_idResource id8bf55e738d4e44b5a21dbe133a42ecbe

3.1.10.5 - 1.0

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

Description

Create Volume Replication.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
region
required
stringRegionkr-west1
name
required
stringReplication volume namereplica-bs-01
cycle
required
stringReplication cycle-

Responses

NameDescriptionExample
request_idRequest idreq-0006064c-c008-458c-8977-19671c6b32d4
resource_idResource id8bf55e738d4e44b5a21dbe133a42ecbe

3.1.11 - Create Volume Snapshot

3.1.11.1 - 1.4

scp-cli baremetal-blockstorage volume snapshot create
--volume_id <value>

Description

Create Volume snapshot.

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

Responses

NameDescriptionExample
account_idAccount id36827d9b643f46c2ae6bb7e63d633bfe
snapshot_idSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
snapshot_nameSnapshot namevo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932
volume_idVolume id92cd16fe8ebc4f73832513a172bf0000

3.1.11.2 - 1.3

scp-cli baremetal-blockstorage volume snapshot create
--volume_id <value>

Description

Create Volume snapshot.

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

Responses

NameDescriptionExample
account_idAccount id36827d9b643f46c2ae6bb7e63d633bfe
snapshot_idSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
snapshot_nameSnapshot namevo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932
volume_idVolume id92cd16fe8ebc4f73832513a172bf0000

3.1.11.3 - 1.2

scp-cli baremetal-blockstorage volume snapshot create
--volume_id <value>

Description

Create Volume snapshot.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.220260531

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

Responses

NameDescriptionExample
account_idAccount id36827d9b643f46c2ae6bb7e63d633bfe
snapshot_idSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
snapshot_nameSnapshot namevo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932
volume_idVolume id92cd16fe8ebc4f73832513a172bf0000

3.1.11.4 - 1.1

scp-cli baremetal-blockstorage volume snapshot create
--volume_id <value>

Description

Create Volume snapshot.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.120260331

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

Responses

NameDescriptionExample
account_idAccount id36827d9b643f46c2ae6bb7e63d633bfe
snapshot_idSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
snapshot_nameSnapshot namevo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932
volume_idVolume id92cd16fe8ebc4f73832513a172bf0000

3.1.11.5 - 1.0

scp-cli baremetal-blockstorage volume snapshot create
--volume_id <value>

Description

Create Volume snapshot.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

Responses

NameDescriptionExample
account_idAccount id36827d9b643f46c2ae6bb7e63d633bfe
snapshot_idSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
snapshot_nameSnapshot namevo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932
volume_idVolume id92cd16fe8ebc4f73832513a172bf0000

3.1.12 - Create Volume Snapshot Rate

3.1.12.1 - 1.4

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

Description

Create Volume snapshot rate.

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
snapshot_rate
required
integerSnapshot rate100

Responses

NameDescriptionExample
is_snapshot_activatedWhether to activate snapshotTrue
snapshot_rateSnapshot rate100
volume_idVolume id92cd16fe8ebc4f73832513a172bf0000

3.1.12.2 - 1.3

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

Description

Create Volume snapshot rate.

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
snapshot_rate
required
integerSnapshot rate100

Responses

NameDescriptionExample
is_snapshot_activatedWhether to activate snapshotTrue
snapshot_rateSnapshot rate100
volume_idVolume id92cd16fe8ebc4f73832513a172bf0000

3.1.12.3 - 1.2

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

Description

Create Volume snapshot rate.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.220260531

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
snapshot_rate
required
integerSnapshot rate100

Responses

NameDescriptionExample
is_snapshot_activatedWhether to activate snapshotTrue
snapshot_rateSnapshot rate100
volume_idVolume id92cd16fe8ebc4f73832513a172bf0000

3.1.12.4 - 1.1

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

Description

Create Volume snapshot rate.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.120260331

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
snapshot_rate
required
integerSnapshot rate100

Responses

NameDescriptionExample
is_snapshot_activatedWhether to activate snapshotTrue
snapshot_rateSnapshot rate100
volume_idVolume id92cd16fe8ebc4f73832513a172bf0000

3.1.12.5 - 1.0

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

Description

Create Volume snapshot rate.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
snapshot_rate
required
integerSnapshot rate100

Responses

NameDescriptionExample
is_snapshot_activatedWhether to activate snapshotTrue
snapshot_rateSnapshot rate100
volume_idVolume id92cd16fe8ebc4f73832513a172bf0000

3.1.13 - Create Volume Snapshot Schedule

3.1.13.1 - 1.4

scp-cli baremetal-blockstorage volume snapshot-schedule create
--volume_id <value>
--hour <value>
[--day_of_week <value>]

Description

Create Volume snapshot schedule.

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
hour
required
integerHour18
day_of_week
optional
stringDay of week(If this field is excluded, the schedule frequency is set to DAILY.)-

Responses

NameDescriptionExample
day_of_weekDay of week
frequencyFrequency DAILYWEEKLY
hourHour18
volume_idVolume id92cd16fe8ebc4f73832513a172bf0000

3.1.13.2 - 1.3

scp-cli baremetal-blockstorage volume snapshot-schedule create
--volume_id <value>
--hour <value>
[--day_of_week <value>]

Description

Create Volume snapshot schedule.

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
hour
required
integerHour18
day_of_week
optional
stringDay of week(If this field is excluded, the schedule frequency is set to DAILY.)-

Responses

NameDescriptionExample
day_of_weekDay of week
frequencyFrequency DAILYWEEKLY
hourHour18
volume_idVolume id92cd16fe8ebc4f73832513a172bf0000

3.1.13.3 - 1.2

scp-cli baremetal-blockstorage volume snapshot-schedule create
--volume_id <value>
--hour <value>
[--day_of_week <value>]

Description

Create Volume snapshot schedule.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.220260531

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
hour
required
integerHour18
day_of_week
optional
stringDay of week(If this field is excluded, the schedule frequency is set to DAILY.)-

Responses

NameDescriptionExample
day_of_weekDay of week
frequencyFrequency DAILYWEEKLY
hourHour18
volume_idVolume id92cd16fe8ebc4f73832513a172bf0000

3.1.13.4 - 1.1

scp-cli baremetal-blockstorage volume snapshot-schedule create
--volume_id <value>
--hour <value>
[--day_of_week <value>]

Description

Create Volume snapshot schedule.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.120260331

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
hour
required
integerHour18
day_of_week
optional
stringDay of week(If this field is excluded, the schedule frequency is set to DAILY.)-

Responses

NameDescriptionExample
day_of_weekDay of week
frequencyFrequency DAILYWEEKLY
hourHour18
volume_idVolume id92cd16fe8ebc4f73832513a172bf0000

3.1.13.5 - 1.0

scp-cli baremetal-blockstorage volume snapshot-schedule create
--volume_id <value>
--hour <value>
[--day_of_week <value>]

Description

Create Volume snapshot schedule.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
hour
required
integerHour18
day_of_week
optional
stringDay of week(If this field is excluded, the schedule frequency is set to DAILY.)-

Responses

NameDescriptionExample
day_of_weekDay of week
frequencyFrequency DAILYWEEKLY
hourHour18
volume_idVolume id92cd16fe8ebc4f73832513a172bf0000

3.1.14 - Delete Volume

3.1.14.1 - 1.4

scp-cli baremetal-blockstorage volume delete
--volume_id <value>

Description

Delete Volume.

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

3.1.14.2 - 1.3

scp-cli baremetal-blockstorage volume delete
--volume_id <value>

Description

Delete Volume.

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

3.1.14.3 - 1.2

scp-cli baremetal-blockstorage volume delete
--volume_id <value>

Description

Delete Volume.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.220260531

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

3.1.14.4 - 1.1

scp-cli baremetal-blockstorage volume delete
--volume_id <value>

Description

Delete Volume.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.120260331

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

3.1.14.5 - 1.0

scp-cli baremetal-blockstorage volume delete
--volume_id <value>

Description

Delete Volume.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

3.1.15 - Delete Volume Group Replication

3.1.15.1 - 1.4

scp-cli baremetal-blockstorage volume-group replication delete
--volume_group_id <value>

Description

Delete Volume Group Replication.

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063

3.1.15.2 - 1.3

scp-cli baremetal-blockstorage volume-group replication delete
--volume_group_id <value>

Description

Delete Volume Group Replication.

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063

3.1.15.3 - 1.2

scp-cli baremetal-blockstorage volume-group replication delete
--volume_group_id <value>

Description

Delete Volume Group Replication.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.220260531

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063

3.1.15.4 - 1.1

scp-cli baremetal-blockstorage volume-group replication delete
--volume_group_id <value>

Description

Delete Volume Group Replication.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.120260331

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063

3.1.15.5 - 1.0

scp-cli baremetal-blockstorage volume-group replication delete
--volume_group_id <value>

Description

Delete Volume Group Replication.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063

3.1.16 - Delete Volume Group Snapshot

3.1.16.1 - 1.4

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

Description

Delete Volume Group snapshot.

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
snapshot_id
required
stringSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063

3.1.16.2 - 1.3

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

Description

Delete Volume Group snapshot.

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
snapshot_id
required
stringSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063

3.1.16.3 - 1.2

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

Description

Delete Volume Group snapshot.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.220260531

Parameters

NameTypeDescriptionExample
snapshot_id
required
stringSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063

3.1.16.4 - 1.1

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

Description

Delete Volume Group snapshot.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.120260331

Parameters

NameTypeDescriptionExample
snapshot_id
required
stringSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063

3.1.16.5 - 1.0

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

Description

Delete Volume Group snapshot.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
snapshot_id
required
stringSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063

3.1.17 - Delete Volume Group Snapshot Schedule

3.1.17.1 - 1.4

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

Description

Delete Volume Group Snapshot Schedule.

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063

3.1.17.2 - 1.3

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

Description

Delete Volume Group Snapshot Schedule.

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063

3.1.17.3 - 1.2

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

Description

Delete Volume Group Snapshot Schedule.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.220260531

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063

3.1.17.4 - 1.1

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

Description

Delete Volume Group Snapshot Schedule.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.120260331

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063

3.1.17.5 - 1.0

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

Description

Delete Volume Group Snapshot Schedule.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063

3.1.18 - Delete Volume Replication

3.1.18.1 - 1.4

scp-cli baremetal-blockstorage volume replication delete
--volume_id <value>

Description

Delete Volume Replication.

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

3.1.18.2 - 1.3

scp-cli baremetal-blockstorage volume replication delete
--volume_id <value>

Description

Delete Volume Replication.

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

3.1.18.3 - 1.2

scp-cli baremetal-blockstorage volume replication delete
--volume_id <value>

Description

Delete Volume Replication.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.220260531

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

3.1.18.4 - 1.1

scp-cli baremetal-blockstorage volume replication delete
--volume_id <value>

Description

Delete Volume Replication.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.120260331

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

3.1.18.5 - 1.0

scp-cli baremetal-blockstorage volume replication delete
--volume_id <value>

Description

Delete Volume Replication.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

3.1.19 - Delete Volume Snapshot

3.1.19.1 - 1.4

scp-cli baremetal-blockstorage volume snapshot delete
--snapshot_id <value>
--volume_id <value>

Description

Delete Volume snapshot.

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
snapshot_id
required
stringSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

3.1.19.2 - 1.3

scp-cli baremetal-blockstorage volume snapshot delete
--snapshot_id <value>
--volume_id <value>

Description

Delete Volume snapshot.

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
snapshot_id
required
stringSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

3.1.19.3 - 1.2

scp-cli baremetal-blockstorage volume snapshot delete
--snapshot_id <value>
--volume_id <value>

Description

Delete Volume snapshot.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.220260531

Parameters

NameTypeDescriptionExample
snapshot_id
required
stringSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

3.1.19.4 - 1.1

scp-cli baremetal-blockstorage volume snapshot delete
--snapshot_id <value>
--volume_id <value>

Description

Delete Volume snapshot.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.120260331

Parameters

NameTypeDescriptionExample
snapshot_id
required
stringSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

3.1.19.5 - 1.0

scp-cli baremetal-blockstorage volume snapshot delete
--snapshot_id <value>
--volume_id <value>

Description

Delete Volume snapshot.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
snapshot_id
required
stringSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

3.1.20 - Delete Volume Snapshot Rate

3.1.20.1 - 1.4

scp-cli baremetal-blockstorage volume snapshot-rate delete
--volume_id <value>

Description

Delete Volume snapshot rate.

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

3.1.20.2 - 1.3

scp-cli baremetal-blockstorage volume snapshot-rate delete
--volume_id <value>

Description

Delete Volume snapshot rate.

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

3.1.20.3 - 1.2

scp-cli baremetal-blockstorage volume snapshot-rate delete
--volume_id <value>

Description

Delete Volume snapshot rate.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.220260531

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

3.1.20.4 - 1.1

scp-cli baremetal-blockstorage volume snapshot-rate delete
--volume_id <value>

Description

Delete Volume snapshot rate.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.120260331

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

3.1.20.5 - 1.0

scp-cli baremetal-blockstorage volume snapshot-rate delete
--volume_id <value>

Description

Delete Volume snapshot rate.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

3.1.21 - Delete Volume Snapshot Schedule

3.1.21.1 - 1.4

scp-cli baremetal-blockstorage volume snapshot-schedule delete
--volume_id <value>

Description

Delete Volume snapshot schedule.

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

3.1.21.2 - 1.3

scp-cli baremetal-blockstorage volume snapshot-schedule delete
--volume_id <value>

Description

Delete Volume snapshot schedule.

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

3.1.21.3 - 1.2

scp-cli baremetal-blockstorage volume snapshot-schedule delete
--volume_id <value>

Description

Delete Volume snapshot schedule.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.220260531

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

3.1.21.4 - 1.1

scp-cli baremetal-blockstorage volume snapshot-schedule delete
--volume_id <value>

Description

Delete Volume snapshot schedule.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.120260331

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

3.1.21.5 - 1.0

scp-cli baremetal-blockstorage volume snapshot-schedule delete
--volume_id <value>

Description

Delete Volume snapshot schedule.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

3.1.22 - Detach Volume

3.1.22.1 - 1.4

scp-cli baremetal-blockstorage volume attachment delete
--volume_id <value>
--attachments <value>

Description

Detach Volume from servers.

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
attachments
required
arrayList of object id to detach-

3.1.22.2 - 1.3

scp-cli baremetal-blockstorage volume attachment delete
--volume_id <value>
--attachments <value>

Description

Detach Volume from servers.

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
attachments
required
arrayList of object id to detach-

3.1.22.3 - 1.2

scp-cli baremetal-blockstorage volume attachment delete
--volume_id <value>
--attachments <value>

Description

Detach Volume from servers.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.220260531

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
attachments
required
arrayList of object id to detach-

3.1.22.4 - 1.1

scp-cli baremetal-blockstorage volume attachment delete
--volume_id <value>
--attachments <value>

Description

Detach Volume from servers.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.120260331

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
attachments
required
arrayList of object id to detach-

3.1.22.5 - 1.0

scp-cli baremetal-blockstorage volume attachment delete
--volume_id <value>
--attachments <value>

Description

Detach Volume from servers.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
attachments
required
arrayList of object id to detach-

3.1.23 - List Volume Group Snapshots

3.1.23.1 - 1.4

scp-cli baremetal-blockstorage volume-group snapshot list
--volume_group_id <value>

Description

Get a list of Volume Group snapshots.

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063

Responses

NameDescriptionExample
created_dtCreated dt2024-08-01T07:07:23.315Z
snapshot_idSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
snapshot_nameSnapshot namevo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932

3.1.23.2 - 1.3

scp-cli baremetal-blockstorage volume-group snapshot list
--volume_group_id <value>

Description

Get a list of Volume Group snapshots.

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063

Responses

NameDescriptionExample
created_dtCreated dt2024-08-01T07:07:23.315Z
snapshot_idSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
snapshot_nameSnapshot namevo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932

3.1.23.3 - 1.2

scp-cli baremetal-blockstorage volume-group snapshot list
--volume_group_id <value>

Description

Get a list of Volume Group snapshots.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.220260531

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063

Responses

NameDescriptionExample
created_dtCreated dt2024-08-01T07:07:23.315Z
snapshot_idSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
snapshot_nameSnapshot namevo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932

3.1.23.4 - 1.1

scp-cli baremetal-blockstorage volume-group snapshot list
--volume_group_id <value>

Description

Get a list of Volume Group snapshots.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.120260331

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063

Responses

NameDescriptionExample
created_dtCreated dt2024-08-01T07:07:23.315Z
snapshot_idSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
snapshot_nameSnapshot namevo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932

3.1.23.5 - 1.0

scp-cli baremetal-blockstorage volume-group snapshot list
--volume_group_id <value>

Description

Get a list of Volume Group snapshots.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063

Responses

NameDescriptionExample
created_dtCreated dt2024-08-01T07:07:23.315Z
snapshot_idSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
snapshot_nameSnapshot namevo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932

3.1.24 - List Volume Groups

3.1.24.1 - 1.4

scp-cli baremetal-blockstorage volume-group list
[--limit <value>]
[--offset <value>]
[--sort <value>]
[--name <value>]

Description

Get a list of Volume Groups.

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
limit
optional
integerNumber to be displayed on the page20
offset
optional
integerOffset0
sort
optional
stringSortcolumn1:asc,column2:desc
name
optional
stringVolume group namevg-01

Responses

NameDescriptionExample
idVolume group idc9ecae8b973b425c81c3817893cd8063
account_idAccount id36827d9b643f46c2ae6bb7e63d633bfe
created_atCreated at2024-08-01T07:06:23.315Z
created_byCreated byf019b1007d9c4763997997622958fa96
modified_atModified at2024-08-01T07:06:25.315Z
modified_byModified byf019b1007d9c4763997997622958fa96
nameVolume group namevg-01
num_of_block_storagesNumber of volumes2
purposeVolume group purposeORG
stateCurrent state
zoneAvailability zonekr-west1-a

3.1.24.2 - 1.3

scp-cli baremetal-blockstorage volume-group list
[--limit <value>]
[--offset <value>]
[--sort <value>]
[--name <value>]

Description

Get a list of Volume Groups.

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
limit
optional
integerNumber to be displayed on the page20
offset
optional
integerOffset0
sort
optional
stringSortcolumn1:asc,column2:desc
name
optional
stringVolume group namevg-01

Responses

NameDescriptionExample
idVolume group idc9ecae8b973b425c81c3817893cd8063
account_idAccount id36827d9b643f46c2ae6bb7e63d633bfe
created_atCreated at2024-08-01T07:06:23.315Z
created_byCreated byf019b1007d9c4763997997622958fa96
modified_atModified at2024-08-01T07:06:25.315Z
modified_byModified byf019b1007d9c4763997997622958fa96
nameVolume group namevg-01
num_of_block_storagesNumber of volumes2
purposeVolume group purposeORG
stateCurrent state

3.1.24.3 - 1.2

scp-cli baremetal-blockstorage volume-group list
[--limit <value>]
[--offset <value>]
[--sort <value>]
[--name <value>]

Description

Get a list of Volume Groups.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.220260531

Parameters

NameTypeDescriptionExample
limit
optional
integerNumber to be displayed on the page20
offset
optional
integerOffset0
sort
optional
stringSortcolumn1:asc,column2:desc
name
optional
stringVolume group namevg-01

Responses

NameDescriptionExample
idVolume group idc9ecae8b973b425c81c3817893cd8063
account_idAccount id36827d9b643f46c2ae6bb7e63d633bfe
created_atCreated at2024-08-01T07:06:23.315Z
created_byCreated byf019b1007d9c4763997997622958fa96
modified_atModified at2024-08-01T07:06:25.315Z
modified_byModified byf019b1007d9c4763997997622958fa96
nameVolume group namevg-01
num_of_block_storagesNumber of volumes2
purposeVolume group purposeORG
stateCurrent state

3.1.24.4 - 1.1

scp-cli baremetal-blockstorage volume-group list
[--limit <value>]
[--offset <value>]
[--sort <value>]
[--name <value>]

Description

Get a list of Volume Groups.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.120260331

Parameters

NameTypeDescriptionExample
limit
optional
integerNumber to be displayed on the page20
offset
optional
integerOffset0
sort
optional
stringSortcolumn1:asc,column2:desc
name
optional
stringVolume group namevg-01

Responses

NameDescriptionExample
idVolume group idc9ecae8b973b425c81c3817893cd8063
account_idAccount id36827d9b643f46c2ae6bb7e63d633bfe
created_atCreated at2024-08-01T07:06:23.315Z
created_byCreated byf019b1007d9c4763997997622958fa96
modified_atModified at2024-08-01T07:06:25.315Z
modified_byModified byf019b1007d9c4763997997622958fa96
nameVolume group namevg-01
num_of_block_storagesNumber of volumes2
purposeVolume group purposeORG
stateCurrent state

3.1.24.5 - 1.0

scp-cli baremetal-blockstorage volume-group list
[--limit <value>]
[--offset <value>]
[--sort <value>]
[--name <value>]

Description

Get a list of Volume Groups.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
limit
optional
integerNumber to be displayed on the page20
offset
optional
integerOffset0
sort
optional
stringSortcolumn1:asc,column2:desc
name
optional
stringVolume group namevg-01

Responses

NameDescriptionExample
idVolume group idc9ecae8b973b425c81c3817893cd8063
account_idAccount id36827d9b643f46c2ae6bb7e63d633bfe
created_atCreated at2024-08-01T07:06:23.315Z
created_byCreated byf019b1007d9c4763997997622958fa96
modified_atModified at2024-08-01T07:06:25.315Z
modified_byModified byf019b1007d9c4763997997622958fa96
nameVolume group namevg-01
num_of_block_storagesNumber of volumes2
purposeVolume group purposeORG
stateCurrent state

3.1.25 - List Volume Snapshots

3.1.25.1 - 1.4

scp-cli baremetal-blockstorage volume snapshot list
--volume_id <value>

Description

Get a list of Volume snapshots.

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

Responses

NameDescriptionExample
created_dtCreated dt2024-08-01T07:07:23.315Z
snapshot_idSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
snapshot_nameSnapshot namevo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932
snapshot_size_mbSnapshot size(MB)0.0

3.1.25.2 - 1.3

scp-cli baremetal-blockstorage volume snapshot list
--volume_id <value>

Description

Get a list of Volume snapshots.

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

Responses

NameDescriptionExample
created_dtCreated dt2024-08-01T07:07:23.315Z
snapshot_idSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
snapshot_nameSnapshot namevo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932
snapshot_size_mbSnapshot size(MB)0.0

3.1.25.3 - 1.2

scp-cli baremetal-blockstorage volume snapshot list
--volume_id <value>

Description

Get a list of Volume snapshots.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.220260531

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

Responses

NameDescriptionExample
created_dtCreated dt2024-08-01T07:07:23.315Z
snapshot_idSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
snapshot_nameSnapshot namevo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932
snapshot_size_mbSnapshot size(MB)0.0

3.1.25.4 - 1.1

scp-cli baremetal-blockstorage volume snapshot list
--volume_id <value>

Description

Get a list of Volume snapshots.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.120260331

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

Responses

NameDescriptionExample
created_dtCreated dt2024-08-01T07:07:23.315Z
snapshot_idSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
snapshot_nameSnapshot namevo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932
snapshot_size_mbSnapshot size(MB)0.0

3.1.25.5 - 1.0

scp-cli baremetal-blockstorage volume snapshot list
--volume_id <value>

Description

Get a list of Volume snapshots.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

Responses

NameDescriptionExample
created_dtCreated dt2024-08-01T07:07:23.315Z
snapshot_idSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
snapshot_nameSnapshot namevo240812063154d4a6abf418e___snapshot-create-bm-blockstorage.2024-08-13_141932
snapshot_size_mbSnapshot size(MB)0.0

3.1.26 - List Volumes

3.1.26.1 - 1.4

scp-cli 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)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
limit
optional
integerNumber to be displayed on the page20
offset
optional
integerOffset0
sort
optional
stringSortcolumn1:asc,column2:desc
name
optional
stringVolume namebs-01
object_name
optional
stringAttached server namebaremetal-server-name
volume_group_name
optional
stringVolume group namevg-01

Responses

NameDescriptionExample
idid7239779c01e3405f82bb71c7f4b55fcd
attachmentsAttached server[{‘id’: ‘d7682135392e42489948c189e29011cc’, ’name’: ‘baremetal-01’, ‘srn’: ‘srn:dev2::8461b55d9088408b8f3cf1f8f9c8bea6:kr-west1::baremetal:baremetal/92cd16fe8ebc4f73832513a172bf0000’}]
created_atCreated at
created_byCreated byf019b1007d9c4763997997622958fa96
disk_typeDisk type
has_relationWhether relation existsFalse
is_in_volume_groupWhether to belong to the volume groupFalse
is_snapshot_activatedWhether to activate snapshotTrue
iscsi_target_ipsList of iscsi ips{‘description’: ‘List of iscsi ips’, ’example’: [‘172.30.4.3’, ‘172.30.4.4’]}
modified_atModified at
modified_byModified byf019b1007d9c4763997997622958fa96
nameVolume namebs-01
purposeVolume purpose
size_gbVolume capacity(GB)10
stateCurrent state
volume_groupVolume group
zoneAvailability zonekr-west1-a

3.1.26.2 - 1.3

scp-cli 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 (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
limit
optional
integerNumber to be displayed on the page20
offset
optional
integerOffset0
sort
optional
stringSortcolumn1:asc,column2:desc
name
optional
stringVolume namebs-01
object_name
optional
stringAttached server namebaremetal-server-name
volume_group_name
optional
stringVolume group namevg-01

Responses

NameDescriptionExample
idid7239779c01e3405f82bb71c7f4b55fcd
attachmentsAttached server[{‘id’: ‘d7682135392e42489948c189e29011cc’, ’name’: ‘baremetal-01’, ‘srn’: ‘srn:dev2::8461b55d9088408b8f3cf1f8f9c8bea6:kr-west1::baremetal:baremetal/92cd16fe8ebc4f73832513a172bf0000’}]
created_atCreated at
created_byCreated byf019b1007d9c4763997997622958fa96
disk_typeDisk type
has_relationWhether relation existsFalse
is_in_volume_groupWhether to belong to the volume groupFalse
is_snapshot_activatedWhether to activate snapshotTrue
iscsi_target_ipsList of iscsi ips{‘description’: ‘List of iscsi ips’, ’example’: [‘172.30.4.3’, ‘172.30.4.4’]}
modified_atModified at
modified_byModified byf019b1007d9c4763997997622958fa96
nameVolume namebs-01
purposeVolume purpose
size_gbVolume capacity(GB)10
stateCurrent state
volume_groupVolume group

3.1.26.3 - 1.2

scp-cli baremetal-blockstorage volume list
[--limit <value>]
[--offset <value>]
[--sort <value>]
[--name <value>]
[--object_name <value>]
[--volume_group_name <value>]

Description

Get a list of Volumes.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.220260531

Parameters

NameTypeDescriptionExample
limit
optional
integerNumber to be displayed on the page20
offset
optional
integerOffset0
sort
optional
stringSortcolumn1:asc,column2:desc
name
optional
stringVolume namebs-01
object_name
optional
stringAttached server namebaremetal-server-name
volume_group_name
optional
stringVolume group namevg-01

Responses

NameDescriptionExample
idid7239779c01e3405f82bb71c7f4b55fcd
attachmentsAttached server[{‘id’: ‘d7682135392e42489948c189e29011cc’, ’name’: ‘baremetal-01’, ‘srn’: ‘srn:dev2::8461b55d9088408b8f3cf1f8f9c8bea6:kr-west1::baremetal:baremetal/92cd16fe8ebc4f73832513a172bf0000’}]
created_atCreated at
created_byCreated byf019b1007d9c4763997997622958fa96
disk_typeDisk type
has_relationWhether relation existsFalse
is_in_volume_groupWhether to belong to the volume groupFalse
is_snapshot_activatedWhether to activate snapshotTrue
iscsi_target_ipsList of iscsi ips{‘description’: ‘List of iscsi ips’, ’example’: [‘172.30.4.3’, ‘172.30.4.4’]}
modified_atModified at
modified_byModified byf019b1007d9c4763997997622958fa96
nameVolume namebs-01
purposeVolume purpose
size_gbVolume capacity(GB)10
stateCurrent state
volume_groupVolume group

3.1.26.4 - 1.1

scp-cli baremetal-blockstorage volume list
[--limit <value>]
[--offset <value>]
[--sort <value>]
[--name <value>]
[--object_name <value>]
[--volume_group_name <value>]

Description

Get a list of Volumes.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.120260331

Parameters

NameTypeDescriptionExample
limit
optional
integerNumber to be displayed on the page20
offset
optional
integerOffset0
sort
optional
stringSortcolumn1:asc,column2:desc
name
optional
stringVolume namebs-01
object_name
optional
stringAttached server namebaremetal-server-name
volume_group_name
optional
stringVolume group namevg-01

Responses

NameDescriptionExample
idid7239779c01e3405f82bb71c7f4b55fcd
attachmentsAttached server[{‘id’: ‘d7682135392e42489948c189e29011cc’, ’name’: ‘baremetal-01’, ‘srn’: ‘srn:dev2::8461b55d9088408b8f3cf1f8f9c8bea6:kr-west1::baremetal:baremetal/92cd16fe8ebc4f73832513a172bf0000’}]
created_atCreated at
created_byCreated byf019b1007d9c4763997997622958fa96
disk_typeDisk type
has_relationWhether relation existsFalse
is_in_volume_groupWhether to belong to the volume groupFalse
is_snapshot_activatedWhether to activate snapshotTrue
iscsi_target_ipsList of iscsi ips{‘description’: ‘List of iscsi ips’, ’example’: [‘172.30.4.3’, ‘172.30.4.4’]}
modified_atModified at
modified_byModified byf019b1007d9c4763997997622958fa96
nameVolume namebs-01
purposeVolume purpose
size_gbVolume capacity(GB)10
stateCurrent state
volume_groupVolume group

3.1.26.5 - 1.0

scp-cli baremetal-blockstorage volume list
[--limit <value>]
[--offset <value>]
[--sort <value>]
[--name <value>]
[--object_name <value>]
[--volume_group_name <value>]

Description

Get a list of Volumes.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
limit
optional
integerNumber to be displayed on the page20
offset
optional
integerOffset0
sort
optional
stringSortcolumn1:asc,column2:desc
name
optional
stringVolume namebs-01
object_name
optional
stringAttached server namebaremetal-server-name
volume_group_name
optional
stringVolume group namevg-01

Responses

NameDescriptionExample
idid7239779c01e3405f82bb71c7f4b55fcd
attachmentsAttached server[{‘id’: ‘d7682135392e42489948c189e29011cc’, ’name’: ‘baremetal-01’, ‘srn’: ‘srn:dev2::8461b55d9088408b8f3cf1f8f9c8bea6:kr-west1::baremetal:baremetal/92cd16fe8ebc4f73832513a172bf0000’}]
created_atCreated at
created_byCreated byf019b1007d9c4763997997622958fa96
disk_typeDisk type
has_relationWhether relation existsFalse
is_in_volume_groupWhether to belong to the volume groupFalse
is_snapshot_activatedWhether to activate snapshotTrue
iscsi_target_ipsList of iscsi ips{‘description’: ‘List of iscsi ips’, ’example’: [‘172.30.4.3’, ‘172.30.4.4’]}
modified_atModified at
modified_byModified byf019b1007d9c4763997997622958fa96
nameVolume namebs-01
purposeVolume purpose
size_gbVolume capacity(GB)10
stateCurrent state
volume_groupVolume group

3.1.27 - Remove Volume Group Member on Volume Group

3.1.27.1 - 1.4

scp-cli baremetal-blockstorage volume-group member remove
--volume_group_id <value>
--volume_ids <value>

Description

Remove Volume Group Member on Volume Group.

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063
volume_ids
required
arrayList of volume(Block Storage) id13666d6c32d4456e8421f7768d0bf225

3.1.27.2 - 1.3

scp-cli baremetal-blockstorage volume-group member remove
--volume_group_id <value>
--volume_ids <value>

Description

Remove Volume Group Member on Volume Group.

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063
volume_ids
required
arrayList of volume(Block Storage) id13666d6c32d4456e8421f7768d0bf225

3.1.27.3 - 1.2

scp-cli baremetal-blockstorage volume-group member remove
--volume_group_id <value>
--volume_ids <value>

Description

Remove Volume Group Member on Volume Group.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.220260531

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063
volume_ids
required
arrayList of volume(Block Storage) id13666d6c32d4456e8421f7768d0bf225

3.1.27.4 - 1.1

scp-cli baremetal-blockstorage volume-group member remove
--volume_group_id <value>
--volume_ids <value>

Description

Remove Volume Group Member on Volume Group.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.120260331

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063
volume_ids
required
arrayList of volume(Block Storage) id13666d6c32d4456e8421f7768d0bf225

3.1.27.5 - 1.0

scp-cli baremetal-blockstorage volume-group member remove
--volume_group_id <value>
--volume_ids <value>

Description

Remove Volume Group Member on Volume Group.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063
volume_ids
required
arrayList of volume(Block Storage) id13666d6c32d4456e8421f7768d0bf225

3.1.28 - Restore Volume Group Snapshot

3.1.28.1 - 1.4

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

Description

Restore Volume Group snapshot.

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
snapshot_id
required
stringSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063

3.1.28.2 - 1.3

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

Description

Restore Volume Group snapshot.

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
snapshot_id
required
stringSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063

3.1.28.3 - 1.2

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

Description

Restore Volume Group snapshot.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.220260531

Parameters

NameTypeDescriptionExample
snapshot_id
required
stringSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063

3.1.28.4 - 1.1

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

Description

Restore Volume Group snapshot.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.120260331

Parameters

NameTypeDescriptionExample
snapshot_id
required
stringSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063

3.1.28.5 - 1.0

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

Description

Restore Volume Group snapshot.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
snapshot_id
required
stringSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063

3.1.29 - Restore Volume Snapshot

3.1.29.1 - 1.4

scp-cli baremetal-blockstorage volume snapshot restore
--snapshot_id <value>
--volume_id <value>

Description

Restore Volume from snapshot.

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
snapshot_id
required
stringSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

3.1.29.2 - 1.3

scp-cli baremetal-blockstorage volume snapshot restore
--snapshot_id <value>
--volume_id <value>

Description

Restore Volume from snapshot.

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
snapshot_id
required
stringSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

3.1.29.3 - 1.2

scp-cli baremetal-blockstorage volume snapshot restore
--snapshot_id <value>
--volume_id <value>

Description

Restore Volume from snapshot.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.220260531

Parameters

NameTypeDescriptionExample
snapshot_id
required
stringSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

3.1.29.4 - 1.1

scp-cli baremetal-blockstorage volume snapshot restore
--snapshot_id <value>
--volume_id <value>

Description

Restore Volume from snapshot.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.120260331

Parameters

NameTypeDescriptionExample
snapshot_id
required
stringSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

3.1.29.5 - 1.0

scp-cli baremetal-blockstorage volume snapshot restore
--snapshot_id <value>
--volume_id <value>

Description

Restore Volume from snapshot.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
snapshot_id
required
stringSnapshot id05600123-6e78-11f0-a3f0-d039eab8d501
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

3.1.30 - Set Volume Group Replication Cycle

3.1.30.1 - 1.4

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

Description

Set Volume Group Replication Cycle.

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063
cycle
required
stringReplication cycle-

3.1.30.2 - 1.3

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

Description

Set Volume Group Replication Cycle.

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063
cycle
required
stringReplication cycle-

3.1.30.3 - 1.2

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

Description

Set Volume Group Replication Cycle.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.220260531

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063
cycle
required
stringReplication cycle-

3.1.30.4 - 1.1

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

Description

Set Volume Group Replication Cycle.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.120260331

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063
cycle
required
stringReplication cycle-

3.1.30.5 - 1.0

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

Description

Set Volume Group Replication Cycle.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063
cycle
required
stringReplication cycle-

3.1.31 - Set Volume Group Replication Policy

3.1.31.1 - 1.4

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

Description

Set Volume Group Replication Policy.

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063
policy
required
stringPolicy-

3.1.31.2 - 1.3

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

Description

Set Volume Group Replication Policy.

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063
policy
required
stringPolicy-

3.1.31.3 - 1.2

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

Description

Set Volume Group Replication Policy.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.220260531

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063
policy
required
stringPolicy-

3.1.31.4 - 1.1

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

Description

Set Volume Group Replication Policy.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.120260331

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063
policy
required
stringPolicy-

3.1.31.5 - 1.0

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

Description

Set Volume Group Replication Policy.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063
policy
required
stringPolicy-

3.1.32 - Set Volume Group Snapshot Schedule

3.1.32.1 - 1.4

scp-cli 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)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063
hour
required
integerHour18
day_of_week
optional
stringDay of week(If this field is excluded, the schedule frequency is set to DAILY.)-

3.1.32.2 - 1.3

scp-cli 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 (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063
hour
required
integerHour18
day_of_week
optional
stringDay of week(If this field is excluded, the schedule frequency is set to DAILY.)-

3.1.32.3 - 1.2

scp-cli baremetal-blockstorage volume-group snapshot-schedule set
--volume_group_id <value>
--hour <value>
[--day_of_week <value>]

Description

Set Volume Group Snapshot Schedule.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.220260531

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063
hour
required
integerHour18
day_of_week
optional
stringDay of week(If this field is excluded, the schedule frequency is set to DAILY.)-

3.1.32.4 - 1.1

scp-cli baremetal-blockstorage volume-group snapshot-schedule set
--volume_group_id <value>
--hour <value>
[--day_of_week <value>]

Description

Set Volume Group Snapshot Schedule.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.120260331

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063
hour
required
integerHour18
day_of_week
optional
stringDay of week(If this field is excluded, the schedule frequency is set to DAILY.)-

3.1.32.5 - 1.0

scp-cli baremetal-blockstorage volume-group snapshot-schedule set
--volume_group_id <value>
--hour <value>
[--day_of_week <value>]

Description

Set Volume Group Snapshot Schedule.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063
hour
required
integerHour18
day_of_week
optional
stringDay 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.4

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

Description

Change volume QoS

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
iops
optional
integerIOPS. If omitted, the existing value will be retained.5000
throughput
optional
integerThroughput. If omitted, the existing value will be retained.250

3.1.33.2 - 1.3

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

Description

Change volume QoS

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
iops
optional
integerIOPS. If omitted, the existing value will be retained.5000
throughput
optional
integerThroughput. If omitted, the existing value will be retained.250

3.1.33.3 - 1.2

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

Description

Change volume QoS

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.220260531

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
iops
optional
integerIOPS. If omitted, the existing value will be retained.5000
throughput
optional
integerThroughput. If omitted, the existing value will be retained.250

3.1.34 - Set Volume Replication Cycle

3.1.34.1 - 1.4

scp-cli baremetal-blockstorage volume replication-cycle set
--volume_id <value>
--cycle <value>

Description

Set Volume Replication Cycle.

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
cycle
required
stringReplication cycle5MIN

3.1.34.2 - 1.3

scp-cli baremetal-blockstorage volume replication-cycle set
--volume_id <value>
--cycle <value>

Description

Set Volume Replication Cycle.

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
cycle
required
stringReplication cycle5MIN

3.1.34.3 - 1.2

scp-cli baremetal-blockstorage volume replication-cycle set
--volume_id <value>
--cycle <value>

Description

Set Volume Replication Cycle.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.220260531

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
cycle
required
stringReplication cycle5MIN

3.1.34.4 - 1.1

scp-cli baremetal-blockstorage volume replication-cycle set
--volume_id <value>
--cycle <value>

Description

Set Volume Replication Cycle.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.120260331

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
cycle
required
stringReplication cycle5MIN

3.1.34.5 - 1.0

scp-cli baremetal-blockstorage volume replication-cycle set
--volume_id <value>
--cycle <value>

Description

Set Volume Replication Cycle.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
cycle
required
stringReplication cycle5MIN

3.1.35 - Set Volume Replication Policy

3.1.35.1 - 1.4

scp-cli baremetal-blockstorage volume replication-policy set
--volume_id <value>
--policy <value>

Description

Set Volume Replication Policy.

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
policy
required
stringPolicy-

3.1.35.2 - 1.3

scp-cli baremetal-blockstorage volume replication-policy set
--volume_id <value>
--policy <value>

Description

Set Volume Replication Policy.

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
policy
required
stringPolicy-

3.1.35.3 - 1.2

scp-cli baremetal-blockstorage volume replication-policy set
--volume_id <value>
--policy <value>

Description

Set Volume Replication Policy.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.220260531

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
policy
required
stringPolicy-

3.1.35.4 - 1.1

scp-cli baremetal-blockstorage volume replication-policy set
--volume_id <value>
--policy <value>

Description

Set Volume Replication Policy.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.120260331

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
policy
required
stringPolicy-

3.1.35.5 - 1.0

scp-cli baremetal-blockstorage volume replication-policy set
--volume_id <value>
--policy <value>

Description

Set Volume Replication Policy.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
policy
required
stringPolicy-

3.1.36 - Set Volume Snapshot Rate

3.1.36.1 - 1.4

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

Description

Set Volume snapshot rate.

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
snapshot_rate
required
integerSnapshot rate100

3.1.36.2 - 1.3

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

Description

Set Volume snapshot rate.

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
snapshot_rate
required
integerSnapshot rate100

3.1.36.3 - 1.2

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

Description

Set Volume snapshot rate.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.220260531

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
snapshot_rate
required
integerSnapshot rate100

3.1.36.4 - 1.1

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

Description

Set Volume snapshot rate.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.120260331

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
snapshot_rate
required
integerSnapshot rate100

3.1.36.5 - 1.0

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

Description

Set Volume snapshot rate.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
snapshot_rate
required
integerSnapshot rate100

3.1.37 - Set Volume Snapshot Schedule

3.1.37.1 - 1.4

scp-cli baremetal-blockstorage volume snapshot-schedule set
--volume_id <value>
--hour <value>
[--day_of_week <value>]

Description

Set Volume snapshot schedule.

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
hour
required
integerHour18
day_of_week
optional
stringDay of week(If this field is excluded, the schedule frequency is set to DAILY.)-

3.1.37.2 - 1.3

scp-cli baremetal-blockstorage volume snapshot-schedule set
--volume_id <value>
--hour <value>
[--day_of_week <value>]

Description

Set Volume snapshot schedule.

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
hour
required
integerHour18
day_of_week
optional
stringDay of week(If this field is excluded, the schedule frequency is set to DAILY.)-

3.1.37.3 - 1.2

scp-cli baremetal-blockstorage volume snapshot-schedule set
--volume_id <value>
--hour <value>
[--day_of_week <value>]

Description

Set Volume snapshot schedule.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.220260531

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
hour
required
integerHour18
day_of_week
optional
stringDay of week(If this field is excluded, the schedule frequency is set to DAILY.)-

3.1.37.4 - 1.1

scp-cli baremetal-blockstorage volume snapshot-schedule set
--volume_id <value>
--hour <value>
[--day_of_week <value>]

Description

Set Volume snapshot schedule.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.120260331

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
hour
required
integerHour18
day_of_week
optional
stringDay of week(If this field is excluded, the schedule frequency is set to DAILY.)-

3.1.37.5 - 1.0

scp-cli baremetal-blockstorage volume snapshot-schedule set
--volume_id <value>
--hour <value>
[--day_of_week <value>]

Description

Set Volume snapshot schedule.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000
hour
required
integerHour18
day_of_week
optional
stringDay of week(If this field is excluded, the schedule frequency is set to DAILY.)-

3.1.38 - Show Volume

3.1.38.1 - 1.4

scp-cli baremetal-blockstorage volume show
--volume_id <value>

Description

Show Volume.

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

Responses

NameDescriptionExample
resultVolume detail

3.1.38.2 - 1.3

scp-cli baremetal-blockstorage volume show
--volume_id <value>

Description

Show Volume.

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

Responses

NameDescriptionExample
resultVolume detail

3.1.38.3 - 1.2

scp-cli baremetal-blockstorage volume show
--volume_id <value>

Description

Show Volume.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.220260531

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

Responses

NameDescriptionExample
resultVolume detail

3.1.38.4 - 1.1

scp-cli baremetal-blockstorage volume show
--volume_id <value>

Description

Show Volume.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.120260331

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

Responses

NameDescriptionExample
resultVolume detail

3.1.38.5 - 1.0

scp-cli baremetal-blockstorage volume show
--volume_id <value>

Description

Show Volume.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

Responses

NameDescriptionExample
resultVolume detail

3.1.39 - Show Volume Group

3.1.39.1 - 1.4

scp-cli baremetal-blockstorage volume-group show
--volume_group_id <value>

Description

Show Volume Group

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063

Responses

NameDescriptionExample
resultVolume group detail

3.1.39.2 - 1.3

scp-cli baremetal-blockstorage volume-group show
--volume_group_id <value>

Description

Show Volume Group

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063

Responses

NameDescriptionExample
resultVolume group detail

3.1.39.3 - 1.2

scp-cli baremetal-blockstorage volume-group show
--volume_group_id <value>

Description

Show Volume Group

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.220260531

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063

Responses

NameDescriptionExample
resultVolume group detail

3.1.39.4 - 1.1

scp-cli baremetal-blockstorage volume-group show
--volume_group_id <value>

Description

Show Volume Group

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.120260331

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063

Responses

NameDescriptionExample
resultVolume group detail

3.1.39.5 - 1.0

scp-cli baremetal-blockstorage volume-group show
--volume_group_id <value>

Description

Show Volume Group

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063

Responses

NameDescriptionExample
resultVolume group detail

3.1.40 - Show Volume Group Replication

3.1.40.1 - 1.4

scp-cli baremetal-blockstorage volume-group replication show
--volume_group_id <value>

Description

Show Volume Group Replication

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063

Responses

NameDescriptionExample
resultVolume group replication detail

3.1.40.2 - 1.3

scp-cli baremetal-blockstorage volume-group replication show
--volume_group_id <value>

Description

Show Volume Group Replication

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063

Responses

NameDescriptionExample
resultVolume group replication detail

3.1.40.3 - 1.2

scp-cli baremetal-blockstorage volume-group replication show
--volume_group_id <value>

Description

Show Volume Group Replication

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.220260531

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063

Responses

NameDescriptionExample
resultVolume group replication detail

3.1.40.4 - 1.1

scp-cli baremetal-blockstorage volume-group replication show
--volume_group_id <value>

Description

Show Volume Group Replication

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.120260331

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063

Responses

NameDescriptionExample
resultVolume group replication detail

3.1.40.5 - 1.0

scp-cli baremetal-blockstorage volume-group replication show
--volume_group_id <value>

Description

Show Volume Group Replication

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
volume_group_id
required
stringVolume group idc9ecae8b973b425c81c3817893cd8063

Responses

NameDescriptionExample
resultVolume group replication detail

3.1.41 - Show Volume Replication

3.1.41.1 - 1.4

scp-cli baremetal-blockstorage volume replication show
--volume_id <value>

Description

Show Volume Replication.

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

Responses

NameDescriptionExample
resultVolume replication detail

3.1.41.2 - 1.3

scp-cli baremetal-blockstorage volume replication show
--volume_id <value>

Description

Show Volume Replication.

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

Responses

NameDescriptionExample
resultVolume replication detail

3.1.41.3 - 1.2

scp-cli baremetal-blockstorage volume replication show
--volume_id <value>

Description

Show Volume Replication.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.220260531

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

Responses

NameDescriptionExample
resultVolume replication detail

3.1.41.4 - 1.1

scp-cli baremetal-blockstorage volume replication show
--volume_id <value>

Description

Show Volume Replication.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.120260331

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

Responses

NameDescriptionExample
resultVolume replication detail

3.1.41.5 - 1.0

scp-cli baremetal-blockstorage volume replication show
--volume_id <value>

Description

Show Volume Replication.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume id92cd16fe8ebc4f73832513a172bf0000

Responses

NameDescriptionExample
resultVolume 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

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

VersionStatusNot Before
1.2CURRENT-
1.1SUPPORTED20261130

CLI Version History

1.2

File Storage CLI has been updated to version 1.2.

Changes

  • [Updated] filestorage volume create - The following argument has been added and changed.
    • NEW --zone - Required argument added. Zone of the volume.
    • UPDATED --type_name - Pattern restriction removed (no longer restricted to predefined values).
  • [Updated] filestorage volume list - The following output columns have been added and removed.
    • NEW zone - Zone of the volume.
    • NEW az_type - Availability zone type.
    • REMOVED type_id - Type ID column has been removed.
  • [Updated] filestorage volume show - The following output fields have been added and removed.
    • NEW zone - Zone of the volume.
    • NEW az_type - Availability zone type.
    • REMOVED type_id - Type ID field has been removed.
  • [Updated] filestorage volume replication create - Response output fields have been added.
    • NEW replication_volume_zone - Zone of the replication volume.
    • NEW source_volume_zone - Zone of the source volume.
  • [Updated] filestorage volume replication list - The following output columns have been added.
    • NEW replication_volume_zone - Zone of the replication volume.
    • NEW source_volume_zone - Zone of the source volume.
  • [Updated] filestorage volume replication show - The following output fields have been added.
    • NEW replication_volume_zone - Zone of the replication volume.
    • NEW source_volume_zone - Zone of the source volume.
  • [Removed] filestorage volume replication region list - List volume replication regions command has been removed.

1.1

File Storage CLI has been updated to version 1.1.

Changes

  • [Updated] filestorage volume create - The --type_name option now accepts additional type values.
    • 1.0 version accepted types: HDD, SSD, HighPerformanceSSD
    • 1.1 version accepts types: HDD, SSD, HighPerformanceSSD, SSD_SAP_E, SSD_SAP_S
  • [Updated] filestorage volume list - The --type_name option now accepts additional type values.
    • 1.0 version accepted types: HDD, SSD, HighPerformanceSSD
    • 1.1 version accepts types: HDD, SSD, HighPerformanceSSD, SSD_SAP_E, SSD_SAP_S

1.0

File Storage CLI has been released.

Changes

  • [New] filestorage volume access rule list - List access rules command has been added.
  • [New] filestorage volume access rule set - Set access rule for volume command has been added.
  • [New] filestorage volume create - Create volume command has been added.
  • [New] filestorage volume delete - Delete volume command has been added.
  • [New] filestorage volume list - List volumes command has been added.
  • [New] filestorage volume replication create - Create volume replication command has been added.
  • [New] filestorage volume replication delete - Delete volume replication command has been added.
  • [New] filestorage volume replication list - List volume replications command has been added.
  • [New] filestorage volume replication region list - List volume replication regions command has been added.
  • [New] filestorage volume replication set - Set volume replication command has been added.
  • [New] filestorage volume replication show - Show volume replication command has been added.
  • [New] filestorage volume set - Set volume command has been added.
  • [New] filestorage volume show - Show volume command has been added.
  • [New] filestorage volume snapshot create - Create snapshot command has been added.
  • [New] filestorage volume snapshot delete - Delete snapshot command has been added.
  • [New] filestorage volume snapshot list - List snapshots command has been added.
  • [New] filestorage volume snapshot schedule create - Create snapshot schedule command has been added.
  • [New] filestorage volume snapshot schedule delete - Delete snapshot schedule command has been added.
  • [New] filestorage volume snapshot schedule list - List snapshot schedules command has been added.
  • [New] filestorage volume snapshot schedule set - Set snapshot schedule command has been added.
  • [New] filestorage volume snapshot set - Restore snapshot command has been added.

4.1 - CLIs

4.1.1 - CreateSnapshot

4.1.1.1 - 1.2

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

Description

Create snapshot

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

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

Responses

NameDescriptionExample
idSnapshot ID40htrre5b-eww25-ff2b-a426-6afefas65a3b
nameSnapshot Namemy_volume.2024-10-01_14215
stateSnapshot Stateavailable
size
created_atCreated At2024-07-30T04:54:33.219373
volume_idVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438

4.1.1.2 - 1.1

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

Description

Create snapshot

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

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

Responses

NameDescriptionExample
idSnapshot ID40htrre5b-eww25-ff2b-a426-6afefas65a3b
nameSnapshot Namemy_volume.2024-10-01_14215
stateSnapshot Stateavailable
size
created_atCreated At2024-07-30T04:54:33.219373
volume_idVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438

4.1.2 - CreateSnapshotSchedule

4.1.2.1 - 1.2

scp-cli 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)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
hour
required
stringHour of the snapshot schedule23
frequency
required
stringFrequency of the snapshotWEEKLY
volume_id
required
stringVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
snapshot_retention_count
optional
integerRetention count10
day_of_week
optional
stringDay of week of the snapshot scheduleMON

Responses

NameDescriptionExample
snapshot_retention_countRetention count10
volume_idVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
snapshot_schedule{}

4.1.2.2 - 1.1

scp-cli 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 (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
hour
required
stringHour of the snapshot schedule23
frequency
required
stringFrequency of the snapshotWEEKLY
volume_id
required
stringVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
snapshot_retention_count
optional
integerRetention count10
day_of_week
optional
stringDay of week of the snapshot scheduleMON

Responses

NameDescriptionExample
snapshot_retention_countRetention count10
volume_idVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
snapshot_schedule{}

4.1.3 - CreateVolume

4.1.3.1 - 1.2

scp-cli filestorage volume create
--zone <value>
--type_name <value>
--protocol <value>
--name <value>
[--snapshot_id <value>]
[--cifs_password <value>]
[--tags <value>]

Description

Create volume

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
zone
required
stringZonekr-west1-a
type_name
required
stringVolume Type NameHDD
protocol
required
stringProtocolNFS
name
required
stringVolume Namemy_volume
snapshot_id
optional
stringSnapshot ID40htrre5b-eww25-ff2b-a426-6afefas65a3b
cifs_password
optional
stringCIFS Passwordcifspwd0!!
tags
optional
array'{"key": "key", "value": "value"}'

Responses

NameDescriptionExample
protocolProtocolNFS
snapshot_idSnapshot ID40htrre5b-eww25-ff2b-a426-6afefas65a3b
type_nameVolume Type NameHDD
volume_idVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
volume_nameVolume Namemy_volume
zoneZonekr-west1-a

4.1.3.2 - 1.1

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

Description

Create volume

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
type_name
required
stringVolume Type NameHDD
protocol
required
stringProtocolNFS
name
required
stringVolume Namemy_volume
snapshot_id
optional
stringSnapshot ID40htrre5b-eww25-ff2b-a426-6afefas65a3b
cifs_password
optional
stringCIFS Passwordcifspwd0!!
tags
optional
array'{"key": "key", "value": "value"}'

Responses

NameDescriptionExample
protocolProtocolNFS
snapshot_idSnapshot ID40htrre5b-eww25-ff2b-a426-6afefas65a3b
type_nameVolume Type NameHDD
volume_idVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
volume_nameVolume Namemy_volume

4.1.4 - CreateVolumeReplication

4.1.4.1 - 1.2

scp-cli filestorage volume replication create
--replication_type <value>
--volume_id <value>
--zone <value>
--replication_frequency <value>
--name <value>
[--cifs_password <value>]
[--backup_retention_count <value>]

Description

Create Volume Replication

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
replication_type
required
stringReplication Typereplication
volume_id
required
stringSource Volume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
zone
required
stringZonekr-west1-a
replication_frequency
required
stringFrequency5min
name
required
stringTarget Volume Namemy_volume
cifs_password
optional
stringCIFS Passwordcifspwd0!!
backup_retention_count
optional
integerBackup Retention Count2

Responses

NameDescriptionExample
replication_idReplication IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
replication_statusReplication Statuscreating
source_volume_idSource Volume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
source_volume_regionSource Regionkr-west1
source_volume_zoneSource Zonekr-west1-a
protocolProtocolNFS
replication_volume_idTarget Volume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
replication_volume_regionTarget Regionkr-west1
replication_volume_zoneTarget Zonekr-west1-a

4.1.4.2 - 1.1

scp-cli 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 (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
replication_type
required
stringReplication Typereplication
volume_id
required
stringSource Volume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
region
required
stringTarget Regionkr-west1
replication_frequency
required
stringFrequency5min
name
required
stringTarget Volume Namemy_volume
cifs_password
optional
stringCIFS Passwordcifspwd0!!
backup_retention_count
optional
integerBackup Retention Count2

Responses

NameDescriptionExample
replication_idReplication IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
replication_statusReplication Statuscreating
source_volume_idSource Volume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
source_volume_regionSource Regionkr-west1
protocolProtocolNFS
replication_volume_idTarget Volume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
replication_volume_regionTarget Regionkr-west1

4.1.5 - DeleteSnapshot

4.1.5.1 - 1.2

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

Description

Delete snapshots

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

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

4.1.5.2 - 1.1

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

Description

Delete snapshots

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

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

4.1.6 - DeleteSnapshotSchedule

4.1.6.1 - 1.2

scp-cli filestorage volume snapshot schedule delete
--snapshot_schedule_id <value>
--volume_id <value>

Description

Delete snapshot schedule

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
snapshot_schedule_id
required
stringSnapshot Schedule IDd02d1a74-1871-4a3d-bdfc-6e60e9ea0f31
volume_id
required
stringVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438

4.1.6.2 - 1.1

scp-cli filestorage volume snapshot schedule delete
--snapshot_schedule_id <value>
--volume_id <value>

Description

Delete snapshot schedule

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
snapshot_schedule_id
required
stringSnapshot Schedule IDd02d1a74-1871-4a3d-bdfc-6e60e9ea0f31
volume_id
required
stringVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438

4.1.7 - DeleteVolume

4.1.7.1 - 1.2

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

Description

Delete volume

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

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

4.1.7.2 - 1.1

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

Description

Delete volume

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

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

4.1.8 - DeleteVolumeReplication

4.1.8.1 - 1.2

scp-cli filestorage volume replication delete
--replication_id <value>
--volume_id <value>

Description

Delete Volume Replication

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

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

4.1.8.2 - 1.1

scp-cli filestorage volume replication delete
--replication_id <value>
--volume_id <value>

Description

Delete Volume Replication

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

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

4.1.9 - ListAccessRules

4.1.9.1 - 1.2

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

Description

List access rules

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

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

Responses

NameDescriptionExample
access_rule_stateAccess Rule Stateactive
object_typeObject TypeVM
object_idObject ID43fq3347-02q4-4aa8-ccf9-affe4917bb6f

4.1.9.2 - 1.1

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

Description

List access rules

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

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

Responses

NameDescriptionExample
access_rule_stateAccess Rule Stateactive
object_typeObject TypeVM
object_idObject ID43fq3347-02q4-4aa8-ccf9-affe4917bb6f

4.1.10 - ListSnapshots

4.1.10.1 - 1.2

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

Description

List snapshots

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

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

Responses

NameDescriptionExample
idSnapshot ID40htrre5b-eww25-ff2b-a426-6afefas65a3b
nameSnapshot Namemy_volume.2024-10-01_14215
stateSnapshot Stateavailable
size
created_atCreated At2024-07-30T04:54:33.219373

4.1.10.2 - 1.1

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

Description

List snapshots

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

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

Responses

NameDescriptionExample
idSnapshot ID40htrre5b-eww25-ff2b-a426-6afefas65a3b
nameSnapshot Namemy_volume.2024-10-01_14215
stateSnapshot Stateavailable
size
created_atCreated At2024-07-30T04:54:33.219373

4.1.11 - ListSnapshotSchedule

4.1.11.1 - 1.2

scp-cli filestorage volume snapshot schedule list
--volume_id <value>

Description

List snapshot schedule

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

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

Responses

NameDescriptionExample
idSnapshot Schedule IDd02d1a74-1871-4a3d-bdfc-6e60e9ea0f31
frequencyFrequency of the snapshotWEEKLY
day_of_weekDay of week of the snapshot scheduleMON
hourHour of the snapshot schedule23

4.1.11.2 - 1.1

scp-cli filestorage volume snapshot schedule list
--volume_id <value>

Description

List snapshot schedule

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

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

Responses

NameDescriptionExample
idSnapshot Schedule IDd02d1a74-1871-4a3d-bdfc-6e60e9ea0f31
frequencyFrequency of the snapshotWEEKLY
day_of_weekDay of week of the snapshot scheduleMON
hourHour of the snapshot schedule23

4.1.12 - ListVolumeReplicationRegion

4.1.12.1 - 1.1

scp-cli filestorage volume replication region list
--replication_type <value>
--source_region_name <value>
--type_name <value>

Description

List Volume Replication Region

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
replication_type
required
stringReplication Typereplication
source_region_name
required
stringRegionkr-west1
type_name
required
stringVolume Type NameHDD

Responses

NameDescriptionExample
regionsReplication Region List[‘kr-west1’]

4.1.13 - ListVolumeReplications

4.1.13.1 - 1.2

scp-cli filestorage volume replication list
--volume_id <value>

Description

List Volume Replications

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

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

Responses

NameDescriptionExample
replication_idReplication IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
replication_frequencyFrequency5min
source_volume_idSource Volume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
source_volume_regionSource Regionkr-west1
source_volume_zoneSource Zonekr-west1-a
source_volume_access_levelSource Access Levelro
replication_volume_idTarget Volume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
replication_volume_regionTarget Regionkr-west1
replication_volume_zoneTarget Zonekr-west1-a
replication_volume_access_levelTarget Access Levelro
replication_typeReplication Typereplication

4.1.13.2 - 1.1

scp-cli filestorage volume replication list
--volume_id <value>

Description

List Volume Replications

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

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

Responses

NameDescriptionExample
replication_idReplication IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
replication_frequencyFrequency5min
source_volume_idSource Volume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
source_volume_regionSource Regionkr-west1
source_volume_access_levelSource Access Levelro
replication_volume_idTarget Volume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
replication_volume_regionTarget Regionkr-west1
replication_volume_access_levelTarget Access Levelro
replication_typeReplication Typereplication

4.1.14 - ListVolumeReplicationZones

4.1.14.1 - 1.2

scp-cli filestorage volume replication zone list
--replication_type <value>
--source_zone <value>
--type_name <value>

Description

List Volume Replication Zones

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
replication_type
required
stringReplication Typereplication
source_zone
required
stringZonekr-west1-a
type_name
required
stringVolume Type NameHDD

Responses

NameDescriptionExample
zonesReplication Region List[‘kr-west1’]

4.1.15 - ListVolumes

4.1.15.1 - 1.2

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

Description

List volumes

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

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

Responses

NameDescriptionExample
idVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
nameVolume Namemy_volume
protocolProtocolNFS
stateVolume Stateavailable
account_idAccount IDrwww523320dfvwbbefefsdvwdadsfa24c
created_atCreated At2024-07-30T04:54:33.219373
type_idVolume Type IDjef22f67-ee83-4gg2-2ab6-3lf774ekfjdu
type_nameVolume Type NameHDD
purposePurposereplication
zoneZonekr-west1-a
az_typeAvailability Zone Typesingle

4.1.15.2 - 1.1

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

Description

List volumes

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

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

Responses

NameDescriptionExample
idVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
nameVolume Namemy_volume
protocolProtocolNFS
stateVolume Stateavailable
account_idAccount IDrwww523320dfvwbbefefsdvwdadsfa24c
created_atCreated At2024-07-30T04:54:33.219373
type_idVolume Type IDjef22f67-ee83-4gg2-2ab6-3lf774ekfjdu
type_nameVolume Type NameHDD
purposePurposereplication

4.1.16 - RestoreSnapshot

4.1.16.1 - 1.2

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

Description

Restore snapshot

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

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

4.1.16.2 - 1.1

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

Description

Restore snapshot

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

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

4.1.17 - SetAccessRule

4.1.17.1 - 1.2

scp-cli 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)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
action
required
stringAccess Rule Actionadd
object_type
required
stringObject TypeVM
object_id
required
stringObject ID43fq3347-02q4-4aa8-ccf9-affe4917bb6f

4.1.17.2 - 1.1

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

Description

Set access rule for volume

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
action
required
stringAccess Rule Actionadd
object_type
required
stringObject TypeVM
object_id
required
stringObject ID43fq3347-02q4-4aa8-ccf9-affe4917bb6f

4.1.18 - SetSnapshotSchedule

4.1.18.1 - 1.2

scp-cli 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)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
snapshot_schedule_id
required
stringSnapshot Schedule IDd02d1a74-1871-4a3d-bdfc-6e60e9ea0f31
volume_id
required
stringVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
hour
required
stringHour of the snapshot schedule23
frequency
required
stringFrequency of the snapshotWEEKLY
snapshot_retention_count
optional
integerRetention count10
day_of_week
optional
stringDay of week of the snapshot scheduleMON

4.1.18.2 - 1.1

scp-cli 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 (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
snapshot_schedule_id
required
stringSnapshot Schedule IDd02d1a74-1871-4a3d-bdfc-6e60e9ea0f31
volume_id
required
stringVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
hour
required
stringHour of the snapshot schedule23
frequency
required
stringFrequency of the snapshotWEEKLY
snapshot_retention_count
optional
integerRetention count10
day_of_week
optional
stringDay of week of the snapshot scheduleMON

4.1.19 - SetVolume

4.1.19.1 - 1.2

scp-cli filestorage volume set
--volume_id <value>
--file_unit_recovery_enabled <value>

Description

Set volume

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
file_unit_recovery_enabled
required
booleanVolume File Unit Recovery EnabledTrue

4.1.19.2 - 1.1

scp-cli filestorage volume set
--volume_id <value>
--file_unit_recovery_enabled <value>

Description

Set volume

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
volume_id
required
stringVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
file_unit_recovery_enabled
required
booleanVolume File Unit Recovery EnabledTrue

4.1.20 - SetVolumeReplication

4.1.20.1 - 1.2

scp-cli 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)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
replication_id
required
stringReplication IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
volume_id
required
stringVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
replication_update_type
required
stringReplication Update Typepolicy
replication_policy
optional
****Policyuse
replication_frequency
optional
****Frequency5min
backup_retention_count
optional
integerBackup Retention Count2

4.1.20.2 - 1.1

scp-cli 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 (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
replication_id
required
stringReplication IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
volume_id
required
stringVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
replication_update_type
required
stringReplication Update Typepolicy
replication_policy
optional
****Policyuse
replication_frequency
optional
****Frequency5min
backup_retention_count
optional
integerBackup Retention Count2

4.1.21 - ShowVolume

4.1.21.1 - 1.2

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

Description

Show volume

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

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

Responses

NameDescriptionExample
idVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
nameVolume Namemy_volume
protocolProtocolNFS
stateVolume Stateavailable
account_idAccount IDrwww523320dfvwbbefefsdvwdadsfa24c
created_atCreated At2024-07-30T04:54:33.219373
type_nameVolume Type NameHDD
purposePurposereplication
pathVolume Mount Pathxxx.xx.xxx:/xxxxxxxx
usage
encryption_enabledVolume Encryption EnabledTrue
file_unit_recovery_enabledVolume File Unit Recovery EnabledTrue
cifs_idCIFS IDcifsid
endpoint_pathVolume Endpoint Pathxxx.xx.xxx.xxx
zoneZonekr-west1-a
az_typeAvailability Zone Typesingle

4.1.21.2 - 1.1

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

Description

Show volume

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

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

Responses

NameDescriptionExample
idVolume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
nameVolume Namemy_volume
protocolProtocolNFS
stateVolume Stateavailable
account_idAccount IDrwww523320dfvwbbefefsdvwdadsfa24c
created_atCreated At2024-07-30T04:54:33.219373
type_idVolume Type IDjef22f67-ee83-4gg2-2ab6-3lf774ekfjdu
type_nameVolume Type NameHDD
purposePurposereplication
pathVolume Mount Pathxxx.xx.xxx:/xxxxxxxx
usage
encryption_enabledVolume Encryption EnabledTrue
file_unit_recovery_enabledVolume File Unit Recovery EnabledTrue
cifs_idCIFS IDcifsid
endpoint_pathVolume Endpoint Pathxxx.xx.xxx.xxx

4.1.22 - ShowVolumeReplication

4.1.22.1 - 1.2

scp-cli filestorage volume replication show
--replication_id <value>
--volume_id <value>

Description

Show Volume Replication

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

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

Responses

NameDescriptionExample
replication_idReplication IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
replication_frequencyFrequency5min
source_volume_idSource Volume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
source_volume_regionSource Regionkr-west1
source_volume_zoneSource Zonekr-west1-a
source_volume_access_levelSource Access Levelro
replication_volume_idTarget Volume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
replication_volume_regionTarget Regionkr-west1
replication_volume_zoneTarget Zonekr-west1-a
replication_volume_access_levelTarget Access Levelro
replication_typeReplication Typereplication
source_volume_nameSource Volume Namemy_volume
replication_policyPolicyuse
replication_statusReplication Statuscreating
replication_volume_nameTarget Volume Namemy_volume
backup_retention_countBackup Retention Count2

4.1.22.2 - 1.1

scp-cli filestorage volume replication show
--replication_id <value>
--volume_id <value>

Description

Show Volume Replication

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

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

Responses

NameDescriptionExample
replication_idReplication IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
replication_frequencyFrequency5min
source_volume_idSource Volume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
source_volume_regionSource Regionkr-west1
source_volume_access_levelSource Access Levelro
replication_volume_idTarget Volume IDbfdbabf2-04d9-4e8b-a205-020f8e6da438
replication_volume_regionTarget Regionkr-west1
replication_volume_access_levelTarget Access Levelro
replication_typeReplication Typereplication
source_volume_nameSource Volume Namemy_volume
replication_policyPolicyuse
replication_statusReplication Statuscreating
replication_volume_nameTarget Volume Namemy_volume
backup_retention_countBackup Retention Count2

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

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.

5.1 - CLIs

5.1.1 - CreateSnapshot

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

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

5.1.2 - CreateVolume

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

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

5.1.3 - DeleteSnapshot

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

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

5.1.4 - DeleteVolume

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

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

5.1.5 - ListAccessRule

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

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

5.1.6 - ListSnapshots

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

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

5.1.7 - ListVolumes

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

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

5.1.8 - RestoreSnapshot

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

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

5.1.9 - SetAccessRule

5.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"}'

5.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"}'

5.1.10 - SetVolumeCapacity

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

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

5.1.11 - ShowVolume

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

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