Storage

• 1: Archive Storage
• 1.1: CLIs
• 1.1.1: CancelArchiving
• 1.1.1.1: 1.1
• 1.1.1.2: 1.0
• 1.1.2: CancelRecovery
• 1.1.2.1: 1.1
• 1.1.2.2: 1.0
• 1.1.3: CreateArchivingPolicy
• 1.1.3.1: 1.1
• 1.1.3.2: 1.0
• 1.1.4: CreateBucket
• 1.1.4.1: 1.1
• 1.1.4.2: 1.0
• 1.1.5: DeleteBucket
• 1.1.5.1: 1.1
• 1.1.5.2: 1.0
• 1.1.6: DeleteBucketObjects
• 1.1.6.1: 1.1
• 1.1.6.2: 1.0
• 1.1.7: DeleteBucketObjectVersions
• 1.1.7.1: 1.1
• 1.1.8: ListArchivingHistories
• 1.1.8.1: 1.1
• 1.1.8.2: 1.0
• 1.1.9: ListArchivingPolicies
• 1.1.9.1: 1.1
• 1.1.9.2: 1.0
• 1.1.10: ListBucketObjects
• 1.1.10.1: 1.1
• 1.1.10.2: 1.0
• 1.1.11: ListBucketObjectVersions
• 1.1.11.1: 1.1
• 1.1.12: ListBuckets
• 1.1.12.1: 1.1
• 1.1.12.2: 1.0
• 1.1.13: ListRecoveryHistories
• 1.1.13.1: 1.1
• 1.1.13.2: 1.0
• 1.1.14: RecoverObjects
• 1.1.14.1: 1.1
• 1.1.14.2: 1.0
• 1.1.15: RecoverObjectVersions
• 1.1.15.1: 1.1
• 1.1.16: SetArchivingPolicy
• 1.1.16.1: 1.1
• 1.1.16.2: 1.0
• 1.1.17: SetArchivingPolicyState
• 1.1.17.1: 1.1
• 1.1.18: SetBucketEncryption
• 1.1.18.1: 1.1
• 1.1.18.2: 1.0
• 1.1.19: SetBucketVersioning
• 1.1.19.1: 1.1
• 1.1.20: ShowArchivingHistory
• 1.1.20.1: 1.1
• 1.1.20.2: 1.0
• 1.1.21: ShowArchivingPolicy
• 1.1.21.1: 1.1
• 1.1.21.2: 1.0
• 1.1.22: ShowBucket
• 1.1.22.1: 1.1
• 1.1.22.2: 1.0
• 1.1.23: ShowBucketEncryption
• 1.1.23.1: 1.1
• 1.1.23.2: 1.0
• 1.1.24: ShowBucketVersioning
• 1.1.24.1: 1.1
• 1.1.25: ShowRecoveryHistory
• 1.1.25.1: 1.1
• 1.1.25.2: 1.0
• 2: Backup
• 2.1: CLIs
• 2.1.1: Check Backup Master Connection State
• 2.1.1.1: 1.2
• 2.1.1.2: 1.1
• 2.1.1.3: 1.0
• 2.1.2: Check Backup Name Duplicate
• 2.1.2.1: 1.2
• 2.1.2.2: 1.1
• 2.1.2.3: 1.0
• 2.1.3: Check Backup Restore Server Name Duplicate
• 2.1.3.1: 1.2
• 2.1.3.2: 1.1
• 2.1.3.3: 1.0
• 2.1.4: Check Filesystem Path Duplication
• 2.1.4.1: 1.2
• 2.1.4.2: 1.1
• 2.1.4.3: 1.0
• 2.1.5: Create Backup
• 2.1.5.1: 1.2
• 2.1.5.2: 1.1
• 2.1.5.3: 1.0
• 2.1.6: Create Backup Agent
• 2.1.6.1: 1.2
• 2.1.6.2: 1.1
• 2.1.6.3: 1.0
• 2.1.7: Delete Backup
• 2.1.7.1: 1.2
• 2.1.7.2: 1.1
• 2.1.7.3: 1.0
• 2.1.8: Delete Backup Agent
• 2.1.8.1: 1.2
• 2.1.8.2: 1.1
• 2.1.8.3: 1.0
• 2.1.9: Delete Backup Restore Target
• 2.1.9.1: 1.2
• 2.1.9.2: 1.1
• 2.1.9.3: 1.0
• 2.1.10: List Agent Backup Restore Target Servers
• 2.1.10.1: 1.2
• 2.1.10.2: 1.1
• 2.1.10.3: 1.0
• 2.1.11: List Backup Agents
• 2.1.11.1: 1.2
• 2.1.11.2: 1.1
• 2.1.11.3: 1.0
• 2.1.12: List Backup Histories
• 2.1.12.1: 1.2
• 2.1.12.2: 1.1
• 2.1.12.3: 1.0
• 2.1.13: List Backup Region Relationship
• 2.1.13.1: 1.2
• 2.1.13.2: 1.1
• 2.1.13.3: 1.0
• 2.1.14: List Backup Restore Histories
• 2.1.14.1: 1.2
• 2.1.14.2: 1.1
• 2.1.14.3: 1.0
• 2.1.15: List Backup Restore Subnets
• 2.1.15.1: 1.2
• 2.1.15.2: 1.1
• 2.1.15.3: 1.0
• 2.1.16: List Backup Restore Targets
• 2.1.16.1: 1.2
• 2.1.16.2: 1.1
• 2.1.16.3: 1.0
• 2.1.17: List Backup Schedules
• 2.1.17.1: 1.2
• 2.1.17.2: 1.1
• 2.1.17.3: 1.0
• 2.1.18: List Backup Targets
• 2.1.18.1: 1.2
• 2.1.18.2: 1.1
• 2.1.18.3: 1.0
• 2.1.19: List Backups
• 2.1.19.1: 1.2
• 2.1.19.2: 1.1
• 2.1.19.3: 1.0
• 2.1.20: List Filesystem Path
• 2.1.20.1: 1.2
• 2.1.21: List Targets of Backup Agent
• 2.1.21.1: 1.2
• 2.1.21.2: 1.1
• 2.1.21.3: 1.0
• 2.1.22: Manual Backup
• 2.1.22.1: 1.2
• 2.1.22.2: 1.1
• 2.1.22.3: 1.0
• 2.1.23: Restore Agent Backup
• 2.1.23.1: 1.2
• 2.1.23.2: 1.1
• 2.1.23.3: 1.0
• 2.1.24: Restore Backup
• 2.1.24.1: 1.2
• 2.1.24.2: 1.1
• 2.1.24.3: 1.0
• 2.1.25: Set Backup Schedule
• 2.1.25.1: 1.2
• 2.1.25.2: 1.1
• 2.1.25.3: 1.0
• 2.1.26: Set Filesystem Path
• 2.1.26.1: 1.2
• 2.1.26.2: 1.1
• 2.1.26.3: 1.0
• 2.1.27: Show Backup
• 2.1.27.1: 1.2
• 2.1.27.2: 1.1
• 2.1.27.3: 1.0
• 2.1.28: Show Backup Agent
• 2.1.28.1: 1.2
• 2.1.28.2: 1.1
• 2.1.28.3: 1.0
• 2.1.29: Show Backup Agent Install File Path
• 2.1.29.1: 1.2
• 2.1.29.2: 1.1
• 2.1.29.3: 1.0
• 2.1.30: Update Replication Use
• 2.1.30.1: 1.2
• 2.1.30.2: 1.1
• 2.1.30.3: 1.0
• 2.1.31: Update Retention Period
• 2.1.31.1: 1.2
• 2.1.31.2: 1.1
• 2.1.31.3: 1.0
• 3: Block Storage(BM)
• 3.1: CLIs
• 3.1.1: Add Volume Group Member on Volume Group
• 3.1.1.1: 1.3
• 3.1.1.2: 1.2
• 3.1.1.3: 1.1
• 3.1.1.4: 1.0
• 3.1.2: Attach Volume
• 3.1.2.1: 1.3
• 3.1.2.2: 1.2
• 3.1.2.3: 1.1
• 3.1.2.4: 1.0
• 3.1.3: Create Volume
• 3.1.3.1: 1.3
• 3.1.3.2: 1.2
• 3.1.3.3: 1.1
• 3.1.3.4: 1.0
• 3.1.4: Create Volume Group
• 3.1.4.1: 1.3
• 3.1.4.2: 1.2
• 3.1.4.3: 1.1
• 3.1.4.4: 1.0
• 3.1.5: Create Volume Group Recovery
• 3.1.5.1: 1.3
• 3.1.5.2: 1.2
• 3.1.5.3: 1.1
• 3.1.6: Create Volume Group Replication
• 3.1.6.1: 1.3
• 3.1.6.2: 1.2
• 3.1.6.3: 1.1
• 3.1.6.4: 1.0
• 3.1.7: Create Volume Group Snapshot
• 3.1.7.1: 1.3
• 3.1.7.2: 1.2
• 3.1.7.3: 1.1
• 3.1.7.4: 1.0
• 3.1.8: Create Volume Group Snapshot Schedule
• 3.1.8.1: 1.3
• 3.1.8.2: 1.2
• 3.1.8.3: 1.1
• 3.1.8.4: 1.0
• 3.1.9: Create Volume Recovery
• 3.1.9.1: 1.3
• 3.1.9.2: 1.2
• 3.1.9.3: 1.1
• 3.1.10: Create Volume Replication
• 3.1.10.1: 1.3
• 3.1.10.2: 1.2
• 3.1.10.3: 1.1
• 3.1.10.4: 1.0
• 3.1.11: Create Volume Snapshot
• 3.1.11.1: 1.3
• 3.1.11.2: 1.2
• 3.1.11.3: 1.1
• 3.1.11.4: 1.0
• 3.1.12: Create Volume Snapshot Rate
• 3.1.12.1: 1.3
• 3.1.12.2: 1.2
• 3.1.12.3: 1.1
• 3.1.12.4: 1.0
• 3.1.13: Create Volume Snapshot Schedule
• 3.1.13.1: 1.3
• 3.1.13.2: 1.2
• 3.1.13.3: 1.1
• 3.1.13.4: 1.0
• 3.1.14: Delete Volume
• 3.1.14.1: 1.3
• 3.1.14.2: 1.2
• 3.1.14.3: 1.1
• 3.1.14.4: 1.0
• 3.1.15: Delete Volume Group Replication
• 3.1.15.1: 1.3
• 3.1.15.2: 1.2
• 3.1.15.3: 1.1
• 3.1.15.4: 1.0
• 3.1.16: Delete Volume Group Snapshot
• 3.1.16.1: 1.3
• 3.1.16.2: 1.2
• 3.1.16.3: 1.1
• 3.1.16.4: 1.0
• 3.1.17: Delete Volume Group Snapshot Schedule
• 3.1.17.1: 1.3
• 3.1.17.2: 1.2
• 3.1.17.3: 1.1
• 3.1.17.4: 1.0
• 3.1.18: Delete Volume Replication
• 3.1.18.1: 1.3
• 3.1.18.2: 1.2
• 3.1.18.3: 1.1
• 3.1.18.4: 1.0
• 3.1.19: Delete Volume Snapshot
• 3.1.19.1: 1.3
• 3.1.19.2: 1.2
• 3.1.19.3: 1.1
• 3.1.19.4: 1.0
• 3.1.20: Delete Volume Snapshot Rate
• 3.1.20.1: 1.3
• 3.1.20.2: 1.2
• 3.1.20.3: 1.1
• 3.1.20.4: 1.0
• 3.1.21: Delete Volume Snapshot Schedule
• 3.1.21.1: 1.3
• 3.1.21.2: 1.2
• 3.1.21.3: 1.1
• 3.1.21.4: 1.0
• 3.1.22: Detach Volume
• 3.1.22.1: 1.3
• 3.1.22.2: 1.2
• 3.1.22.3: 1.1
• 3.1.22.4: 1.0
• 3.1.23: List Volume Group Snapshots
• 3.1.23.1: 1.3
• 3.1.23.2: 1.2
• 3.1.23.3: 1.1
• 3.1.23.4: 1.0
• 3.1.24: List Volume Groups
• 3.1.24.1: 1.3
• 3.1.24.2: 1.2
• 3.1.24.3: 1.1
• 3.1.24.4: 1.0
• 3.1.25: List Volume Snapshots
• 3.1.25.1: 1.3
• 3.1.25.2: 1.2
• 3.1.25.3: 1.1
• 3.1.25.4: 1.0
• 3.1.26: List Volumes
• 3.1.26.1: 1.3
• 3.1.26.2: 1.2
• 3.1.26.3: 1.1
• 3.1.26.4: 1.0
• 3.1.27: Remove Volume Group Member on Volume Group
• 3.1.27.1: 1.3
• 3.1.27.2: 1.2
• 3.1.27.3: 1.1
• 3.1.27.4: 1.0
• 3.1.28: Restore Volume Group Snapshot
• 3.1.28.1: 1.3
• 3.1.28.2: 1.2
• 3.1.28.3: 1.1
• 3.1.28.4: 1.0
• 3.1.29: Restore Volume Snapshot
• 3.1.29.1: 1.3
• 3.1.29.2: 1.2
• 3.1.29.3: 1.1
• 3.1.29.4: 1.0
• 3.1.30: Set Volume Group Replication Cycle
• 3.1.30.1: 1.3
• 3.1.30.2: 1.2
• 3.1.30.3: 1.1
• 3.1.30.4: 1.0
• 3.1.31: Set Volume Group Replication Policy
• 3.1.31.1: 1.3
• 3.1.31.2: 1.2
• 3.1.31.3: 1.1
• 3.1.31.4: 1.0
• 3.1.32: Set Volume Group Snapshot Schedule
• 3.1.32.1: 1.3
• 3.1.32.2: 1.2
• 3.1.32.3: 1.1
• 3.1.32.4: 1.0
• 3.1.33: Set Volume QoS
• 3.1.33.1: 1.3
• 3.1.33.2: 1.2
• 3.1.34: Set Volume Replication Cycle
• 3.1.34.1: 1.3
• 3.1.34.2: 1.2
• 3.1.34.3: 1.1
• 3.1.34.4: 1.0
• 3.1.35: Set Volume Replication Policy
• 3.1.35.1: 1.3
• 3.1.35.2: 1.2
• 3.1.35.3: 1.1
• 3.1.35.4: 1.0
• 3.1.36: Set Volume Snapshot Rate
• 3.1.36.1: 1.3
• 3.1.36.2: 1.2
• 3.1.36.3: 1.1
• 3.1.36.4: 1.0
• 3.1.37: Set Volume Snapshot Schedule
• 3.1.37.1: 1.3
• 3.1.37.2: 1.2
• 3.1.37.3: 1.1
• 3.1.37.4: 1.0
• 3.1.38: Show Volume
• 3.1.38.1: 1.3
• 3.1.38.2: 1.2
• 3.1.38.3: 1.1
• 3.1.38.4: 1.0
• 3.1.39: Show Volume Group
• 3.1.39.1: 1.3
• 3.1.39.2: 1.2
• 3.1.39.3: 1.1
• 3.1.39.4: 1.0
• 3.1.40: Show Volume Group Replication
• 3.1.40.1: 1.3
• 3.1.40.2: 1.2
• 3.1.40.3: 1.1
• 3.1.40.4: 1.0
• 3.1.41: Show Volume Replication
• 3.1.41.1: 1.3
• 3.1.41.2: 1.2
• 3.1.41.3: 1.1
• 3.1.41.4: 1.0
• 4: File Storage
• 4.1: CLIs
• 4.1.1: CreateSnapshot
• 4.1.1.1: 1.1
• 4.1.1.2: 1.0
• 4.1.2: CreateSnapshotSchedule
• 4.1.2.1: 1.1
• 4.1.2.2: 1.0
• 4.1.3: CreateVolume
• 4.1.3.1: 1.1
• 4.1.3.2: 1.0
• 4.1.4: CreateVolumeReplication
• 4.1.4.1: 1.1
• 4.1.4.2: 1.0
• 4.1.5: DeleteSnapshot
• 4.1.5.1: 1.1
• 4.1.5.2: 1.0
• 4.1.6: DeleteSnapshotSchedule
• 4.1.6.1: 1.1
• 4.1.6.2: 1.0
• 4.1.7: DeleteVolume
• 4.1.7.1: 1.1
• 4.1.7.2: 1.0
• 4.1.8: DeleteVolumeReplication
• 4.1.8.1: 1.1
• 4.1.8.2: 1.0
• 4.1.9: ListAccessRules
• 4.1.9.1: 1.1
• 4.1.9.2: 1.0
• 4.1.10: ListSnapshots
• 4.1.10.1: 1.1
• 4.1.10.2: 1.0
• 4.1.11: ListSnapshotSchedule
• 4.1.11.1: 1.1
• 4.1.11.2: 1.0
• 4.1.12: ListVolumeReplicationRegion
• 4.1.12.1: 1.1
• 4.1.12.2: 1.0
• 4.1.13: ListVolumeReplications
• 4.1.13.1: 1.1
• 4.1.13.2: 1.0
• 4.1.14: ListVolumes
• 4.1.14.1: 1.1
• 4.1.14.2: 1.0
• 4.1.15: RestoreSnapshot
• 4.1.15.1: 1.1
• 4.1.15.2: 1.0
• 4.1.16: SetAccessRule
• 4.1.16.1: 1.1
• 4.1.16.2: 1.0
• 4.1.17: SetSnapshotSchedule
• 4.1.17.1: 1.1
• 4.1.17.2: 1.0
• 4.1.18: SetVolume
• 4.1.18.1: 1.1
• 4.1.18.2: 1.0
• 4.1.19: SetVolumeReplication
• 4.1.19.1: 1.1
• 4.1.19.2: 1.0
• 4.1.20: ShowVolume
• 4.1.20.1: 1.1
• 4.1.20.2: 1.0
• 4.1.21: ShowVolumeReplication
• 4.1.21.1: 1.1
• 4.1.21.2: 1.0
• 5: Parallel File Storage
• 5.1: CLIs
• 5.1.1: CreateSnapshot
• 5.1.1.1: 1.0
• 5.1.2: CreateVolume
• 5.1.2.1: 1.0
• 5.1.3: DeleteSnapshot
• 5.1.3.1: 1.0
• 5.1.4: DeleteVolume
• 5.1.4.1: 1.0
• 5.1.5: ListAccessRule
• 5.1.5.1: 1.0
• 5.1.6: ListSnapshots
• 5.1.6.1: 1.0
• 5.1.7: ListVolumes
• 5.1.7.1: 1.0
• 5.1.8: RestoreSnapshot
• 5.1.8.1: 1.0
• 5.1.9: SetAccessRule
• 5.1.9.1: 1.0
• 5.1.10: SetVolumeCapacity
• 5.1.10.1: 1.0
• 5.1.11: ShowVolume
• 5.1.11.1: 1.0

1 - Archive Storage

Overview

Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.

This guide provides a brief description of Archive Storage service and how to call CLI.

Version

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

1.1 - CLIs

1.1.1 - CancelArchiving

1.1.1.1 - 1.1

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

Description

Cancel a specific archiving

State ACTIVE (CURRENT)

Parameters

1.1.1.2 - 1.0

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

Description

Cancel a specific archiving

State ACTIVE (DEPRECATED)

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

Parameters

1.1.2 - CancelRecovery

1.1.2.1 - 1.1

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

Description

Cancel a specific recovery

State ACTIVE (CURRENT)

Parameters

1.1.2.2 - 1.0

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

Description

Cancel a specific 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.

Parameters

1.1.3 - CreateArchivingPolicy

1.1.3.1 - 1.1

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

Description

Create an archivingPolicy

State ACTIVE (CURRENT)

Parameters

Responses

1.1.3.2 - 1.0

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

Description

Create an archivingPolicy

State ACTIVE (DEPRECATED)

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

Parameters

Responses

1.1.4 - CreateBucket

1.1.4.1 - 1.1

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

Description

Create a bucket

State ACTIVE (CURRENT)

Parameters

Responses

1.1.4.2 - 1.0

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

Description

Create a bucket

State ACTIVE (DEPRECATED)

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

Parameters

Responses

1.1.5 - DeleteBucket

1.1.5.1 - 1.1

scpcli archivestorage bucket delete
--bucket_id <value>

Description

Delete a specific bucket

State ACTIVE (CURRENT)

Parameters

1.1.5.2 - 1.0

scpcli archivestorage bucket delete
--bucket_id <value>

Description

Delete a specific bucket

State ACTIVE (DEPRECATED)

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

Parameters

1.1.6 - DeleteBucketObjects

1.1.6.1 - 1.1

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

Description

Delete Bucket Objects

State ACTIVE (CURRENT)

Parameters

1.1.6.2 - 1.0

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

Description

Delete Bucket Objects

State ACTIVE (DEPRECATED)

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

Parameters

1.1.7 - DeleteBucketObjectVersions

1.1.7.1 - 1.1

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

Description

Delete Bucket Object Versions

State ACTIVE (CURRENT)

Parameters

1.1.8 - ListArchivingHistories

1.1.8.1 - 1.1

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

Description

List archiving histories

State ACTIVE (CURRENT)

Parameters

Responses

1.1.8.2 - 1.0

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

Description

List archiving histories

State ACTIVE (DEPRECATED)

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

Parameters

Responses

1.1.9 - ListArchivingPolicies

1.1.9.1 - 1.1

scpcli archivestorage archiving policy list
--bucket_id <value>

Description

List archiving policies

State ACTIVE (CURRENT)

Parameters

Responses

1.1.9.2 - 1.0

scpcli archivestorage archiving policy list
--bucket_id <value>

Description

List archiving policies

State ACTIVE (DEPRECATED)

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

Parameters

Responses

1.1.10 - ListBucketObjects

1.1.10.1 - 1.1

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

Description

List Bucket Objects

State ACTIVE (CURRENT)

Parameters

Responses

1.1.10.2 - 1.0

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

Description

List Bucket Objects

State ACTIVE (DEPRECATED)

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

Parameters

Responses

1.1.11 - ListBucketObjectVersions

1.1.11.1 - 1.1

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

Description

List Bucket Object Versions

State ACTIVE (CURRENT)

Parameters

Responses

1.1.12 - ListBuckets

1.1.12.1 - 1.1

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

Description

List Buckets

State ACTIVE (CURRENT)

Parameters

Responses

1.1.12.2 - 1.0

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

Description

List Buckets

State ACTIVE (DEPRECATED)

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

Parameters

Responses

1.1.13 - ListRecoveryHistories

1.1.13.1 - 1.1

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

Description

List recovery histories

State ACTIVE (CURRENT)

Parameters

Responses

1.1.13.2 - 1.0

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

Description

List recovery histories

State ACTIVE (DEPRECATED)

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

Parameters

Responses

1.1.14 - RecoverObjects

1.1.14.1 - 1.1

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

Description

Recover Objects to objectstorage

State ACTIVE (CURRENT)

Parameters

1.1.14.2 - 1.0

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

Description

Recover Objects to objectstorage

State ACTIVE (DEPRECATED)

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

Parameters

1.1.15 - RecoverObjectVersions

1.1.15.1 - 1.1

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

Description

Recover Object Versions to objectstorage

State ACTIVE (CURRENT)

Parameters

1.1.16 - SetArchivingPolicy

1.1.16.1 - 1.1

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

Description

Set archivingPolicy

State ACTIVE (CURRENT)

Parameters

1.1.16.2 - 1.0

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

Description

Set archivingPolicy

State ACTIVE (DEPRECATED)

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

Parameters

1.1.17 - SetArchivingPolicyState

1.1.17.1 - 1.1

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

Description

Set archivingPolicy state

State ACTIVE (CURRENT)

Parameters

1.1.18 - SetBucketEncryption

1.1.18.1 - 1.1

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

Description

Set a specific bucket encryption

State ACTIVE (CURRENT)

Parameters

1.1.18.2 - 1.0

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

Description

Set a specific bucket encryption

State ACTIVE (DEPRECATED)

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

Parameters

1.1.19 - SetBucketVersioning

1.1.19.1 - 1.1

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

Description

set a specific bucket versioning

State ACTIVE (CURRENT)

Parameters

1.1.20 - ShowArchivingHistory

1.1.20.1 - 1.1

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

Description

Show an archiving history

State ACTIVE (CURRENT)

Parameters

Responses

1.1.20.2 - 1.0

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

Description

Show an archiving history

State ACTIVE (DEPRECATED)

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

Parameters

Responses

1.1.21 - ShowArchivingPolicy

1.1.21.1 - 1.1

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

Description

Show an archivingPolicy

State ACTIVE (CURRENT)

Parameters

Responses

1.1.21.2 - 1.0

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

Description

Show an archivingPolicy

State ACTIVE (DEPRECATED)

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

Parameters

Responses

1.1.22 - ShowBucket

1.1.22.1 - 1.1

scpcli archivestorage bucket show
--bucket_id <value>

Description

Show a specific bucket

State ACTIVE (CURRENT)

Parameters

Responses

1.1.22.2 - 1.0

scpcli archivestorage bucket show
--bucket_id <value>

Description

Show a specific bucket

State ACTIVE (DEPRECATED)

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

Parameters

Responses

1.1.23 - ShowBucketEncryption

1.1.23.1 - 1.1

scpcli archivestorage bucket encryption show
--bucket_id <value>

Description

Show a specific bucket encryption

State ACTIVE (CURRENT)

Parameters

Responses

1.1.23.2 - 1.0

scpcli archivestorage bucket encryption show
--bucket_id <value>

Description

Show a specific bucket encryption

State ACTIVE (DEPRECATED)

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

Parameters

Responses

1.1.24 - ShowBucketVersioning

1.1.24.1 - 1.1

scpcli archivestorage bucket versioning show
--bucket_id <value>

Description

show a specific bucket versioning

State ACTIVE (CURRENT)

Parameters

Responses

1.1.25 - ShowRecoveryHistory

1.1.25.1 - 1.1

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

Description

Show a recovery history

State ACTIVE (CURRENT)

Parameters

Responses

1.1.25.2 - 1.0

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

Description

Show a recovery history

State ACTIVE (DEPRECATED)

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

Parameters

Responses

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.

2.1 - CLIs

2.1.1 - Check Backup Master Connection State

2.1.1.1 - 1.2

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

Description

Check Backup master connection state.

State ACTIVE (CURRENT)

Parameters

Responses

2.1.1.2 - 1.1

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

Parameters

Responses

2.1.1.3 - 1.0

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

Parameters

Responses

2.1.2 - Check Backup Name Duplicate

2.1.2.1 - 1.2

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

Description

Check for duplicate backup names.

State ACTIVE (CURRENT)

Parameters

Responses

2.1.2.2 - 1.1

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

Parameters

Responses

2.1.2.3 - 1.0

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

Parameters

Responses

2.1.3 - Check Backup Restore Server Name Duplicate

2.1.3.1 - 1.2

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

Description

Check for duplicate restore server name.

State ACTIVE (CURRENT)

Parameters

Responses

2.1.3.2 - 1.1

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

Parameters

Responses

2.1.3.3 - 1.0

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

Parameters

Responses

2.1.4 - Check Filesystem Path Duplication

2.1.4.1 - 1.2

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

Description

Check filesystem path duplication.

State ACTIVE (CURRENT)

Parameters

Responses

2.1.4.2 - 1.1

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

Parameters

Responses

2.1.4.3 - 1.0

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

Parameters

Responses

2.1.5 - Create Backup

2.1.5.1 - 1.2

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

Description

Create a Backup.

State ACTIVE (CURRENT)

Parameters

Responses

2.1.5.2 - 1.1

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

Description

Create a Backup.

State ACTIVE (DEPRECATED)

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

Parameters

Responses

2.1.5.3 - 1.0

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

Description

Create a Backup.

State ACTIVE (DEPRECATED)

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

Parameters

Responses

2.1.6 - Create Backup Agent

2.1.6.1 - 1.2

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

Description

Create a Backup Agent.

State ACTIVE (CURRENT)

Parameters

Responses

2.1.6.2 - 1.1

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

Parameters

Responses

2.1.6.3 - 1.0

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

Parameters

Responses

2.1.7 - Delete Backup

2.1.7.1 - 1.2

scpcli backup backup delete
--backup_id <value>

Description

Terminate the Backup.

State ACTIVE (CURRENT)

Parameters

2.1.7.2 - 1.1

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

Parameters

2.1.7.3 - 1.0

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

Parameters

2.1.8 - Delete Backup Agent

2.1.8.1 - 1.2

scpcli backup backup agent delete
--backup_agent_id <value>

Description

Terminate the Backup Agent.

State ACTIVE (CURRENT)

Parameters

2.1.8.2 - 1.1

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

Parameters

2.1.8.3 - 1.0

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

Parameters

2.1.9 - Delete Backup Restore Target

2.1.9.1 - 1.2

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

Description

Delete Backup restore target.

State ACTIVE (CURRENT)

Parameters

2.1.9.2 - 1.1

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

Parameters

2.1.9.3 - 1.0

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

Parameters

2.1.10 - List Agent Backup Restore Target Servers

2.1.10.1 - 1.2

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

Description

List Agent Backup restore target servers.

State ACTIVE (CURRENT)

Parameters

Responses

2.1.10.2 - 1.1

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

Description

List Agent Backup restore target servers.

State ACTIVE (DEPRECATED)

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

Parameters

Responses

2.1.10.3 - 1.0

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

Description

List Agent Backup restore target servers.

State ACTIVE (DEPRECATED)

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

Parameters

Responses

2.1.11 - List Backup Agents

2.1.11.1 - 1.2

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

Description

List Backup Agents.

State ACTIVE (CURRENT)

Parameters

Responses

2.1.11.2 - 1.1

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

Description

List Backup Agents.

State ACTIVE (DEPRECATED)

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

Parameters

Responses

2.1.11.3 - 1.0

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

Description

List Backup Agents.

State ACTIVE (DEPRECATED)

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

Parameters

Responses

2.1.12 - List Backup Histories

2.1.12.1 - 1.2

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

Description

List Backup histories.

State ACTIVE (CURRENT)

Parameters

Responses

2.1.12.2 - 1.1

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

Description

List Backup histories.

State ACTIVE (DEPRECATED)

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

Parameters

Responses

2.1.12.3 - 1.0

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

Description

List Backup histories.

State ACTIVE (DEPRECATED)

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

Parameters

Responses

2.1.13 - List Backup Region Relationship

2.1.13.1 - 1.2

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

Description

List Backup Region Relationship.

State ACTIVE (CURRENT)

Parameters

Responses

2.1.13.2 - 1.1

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

Description

List Backup Region Relationship.

State ACTIVE (DEPRECATED)

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

Parameters

Responses

2.1.13.3 - 1.0

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

Description

List Backup Region Relationship.

State ACTIVE (DEPRECATED)

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

Parameters

Responses

2.1.14 - List Backup Restore Histories

2.1.14.1 - 1.2

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

Description

List Backup restore histories.

State ACTIVE (CURRENT)

Parameters

Responses

2.1.14.2 - 1.1

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

Description

List Backup restore histories.

State ACTIVE (DEPRECATED)

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

Parameters