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

Return to the regular view of this page.

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 - CLIs

1.1 - CancelArchiving

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.2 - CancelRecovery

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.3 - CreateArchivingPolicy

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.4 - CreateBucket

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.5 - DeleteArchivingPolicy

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.6 - DeleteBucket

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

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.8 - DeleteBucketObjectVersions

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.9 - ListArchivingHistories

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.10 - ListArchivingPolicies

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.11 - ListBucketObjects

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.12 - ListBucketObjectVersions

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.13 - ListBuckets

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.14 - ListRecoveryHistories

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.15 - RecoverObjects

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.16 - RecoverObjectVersions

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.17 - SetArchivingPolicy

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.18 - SetArchivingPolicyState

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.19 - SetBucketEncryption

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.20 - SetBucketVersioning

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.21 - ShowArchivingHistory

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.22 - ShowArchivingPolicy

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.23 - ShowBucket

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.24 - ShowBucketEncryption

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.25 - ShowBucketVersioning

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.26 - ShowRecoveryHistory

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[]