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

Return to the regular view of this page.

Archive Storage

1: CLIs

1.1: CancelArchiving

1.1.1: 1.1
1.1.2: 1.0

1.2: CancelRecovery

1.2.1: 1.1
1.2.2: 1.0

1.3: CreateArchivingPolicy

1.3.1: 1.1
1.3.2: 1.0

1.4: CreateBucket

1.4.1: 1.1
1.4.2: 1.0

1.5: DeleteBucket

1.5.1: 1.1
1.5.2: 1.0

1.6: DeleteBucketObjects

1.6.1: 1.1
1.6.2: 1.0

1.7: DeleteBucketObjectVersions

1.7.1: 1.1

1.8: ListArchivingHistories

1.8.1: 1.1
1.8.2: 1.0

1.9: ListArchivingPolicies

1.9.1: 1.1
1.9.2: 1.0

1.10: ListBucketObjects

1.10.1: 1.1
1.10.2: 1.0

1.11: ListBucketObjectVersions

1.11.1: 1.1

1.12: ListBuckets

1.12.1: 1.1
1.12.2: 1.0

1.13: ListRecoveryHistories

1.13.1: 1.1
1.13.2: 1.0

1.14: RecoverObjects

1.14.1: 1.1
1.14.2: 1.0

1.15: RecoverObjectVersions

1.15.1: 1.1

1.16: SetArchivingPolicy

1.16.1: 1.1
1.16.2: 1.0

1.17: SetArchivingPolicyState

1.17.1: 1.1

1.18: SetBucketEncryption

1.18.1: 1.1
1.18.2: 1.0

1.19: SetBucketVersioning

1.19.1: 1.1

1.20: ShowArchivingHistory

1.20.1: 1.1
1.20.2: 1.0

1.21: ShowArchivingPolicy

1.21.1: 1.1
1.21.2: 1.0

1.22: ShowBucket

1.22.1: 1.1
1.22.2: 1.0

1.23: ShowBucketEncryption

1.23.1: 1.1
1.23.2: 1.0

1.24: ShowBucketVersioning

1.24.1: 1.1

1.25: ShowRecoveryHistory

1.25.1: 1.1
1.25.2: 1.0

Overview

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

This guide provides a brief description of 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.

Version	Status	Not Before
1.1	CURRENT	-
1.0	DEPRECATED	20251231

1 - CLIs

1.1 - CancelArchiving

1.1.1 - 1.1

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

Description

Cancel a specific archiving

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
bucket_id required	string	Bucket ID	`3d036efe-f576-48b0-8375-6d3704a95b63`
id required	string	Archiving History ID	`EXE-8f35b491-a060-453b-b825-e78440ca46de`

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.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
bucket_id required	string	Bucket ID	`3d036efe-f576-48b0-8375-6d3704a95b63`
id required	string	Archiving History ID	`EXE-8f35b491-a060-453b-b825-e78440ca46de`

1.2 - CancelRecovery

1.2.1 - 1.1

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

Description

Cancel a specific recovery

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
bucket_id required	string	Bucket ID	`7d8d8c2b-d02a-421e-a6e3-5b981bfb507f`
id required	string	Recovery History ID	`EXE-9df439a5-9e6d-46a4-806e-1e9991520763`

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.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
bucket_id required	string	Bucket ID	`7d8d8c2b-d02a-421e-a6e3-5b981bfb507f`
id required	string	Recovery History ID	`EXE-9df439a5-9e6d-46a4-806e-1e9991520763`

1.3 - CreateArchivingPolicy

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)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
bucket_id required	string	Bucket ID	`138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`
object_path required	string	Object Path	`/`
object_lifecycle required	string	Object LifeCycle	`1`
archiving_source_bucket_name required	string	Archiving Source Bucket Name	`obs-bucket-name`

Responses

Name	Description	Example
id	Archiving Policy ID	SCH-XXXXXXX
bucket_id	Bucket ID	138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
archiving_source	Archiving Source
object_lifecycle	Object LifeCycle	1
state	Archiving Policy State	ACTIVE

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.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
bucket_id required	string	Bucket ID	`138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`
object_path required	string	Object Path	`/`
object_lifecycle required	string	Object LifeCycle	`1`
archiving_source_bucket_name required	string	Archiving Source Bucket Name	`obs-bucket-name`

Responses

Name	Description	Example
id	Archiving Policy ID	SCH-XXXXXXX
bucket_id	Bucket ID	138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
archiving_source	Archiving Source
object_lifecycle	Object LifeCycle	1
state	Archiving Policy State	ACTIVE

1.4 - CreateBucket

1.4.1 - 1.1

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

Description

Create a bucket

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
name required	string	Bucket name	`astest`
tags optional	array	Tag List	`'{"key": "key", "value": "value"}'`

Responses

Name	Description	Example
id	Bucket ID	138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2

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.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
name required	string	Bucket name	`astest`
tags optional	array	Tag List	`'{"key": "key", "value": "value"}'`

Responses

Name	Description	Example
id	Bucket ID	138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2

1.5 - DeleteBucket

1.5.1 - 1.1

scpcli archivestorage bucket delete
--bucket_id <value>

Description

Delete a specific bucket

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
bucket_id required	string	Bucket ID	`138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`

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.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
bucket_id required	string	Bucket ID	`138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`

1.6 - DeleteBucketObjects

1.6.1 - 1.1

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

Description

Delete Bucket Objects

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
bucket_id required	string	Bucket ID	`138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`
paths required	array	Object Path List	`test/`

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.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
bucket_id required	string	Bucket ID	`138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`
paths required	array	Object Path List	`test/`

1.7 - DeleteBucketObjectVersions

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)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
bucket_id required	string	Bucket ID	`138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`
versions required	array	Object Version List	`Oc9nEYWV.6VjzsIMXFZWM1zL8HcYvKl`
path required	string	Object Path	`hello/my_file.txt`

1.8 - ListArchivingHistories

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)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
start_at_to required	string	Start at to	`2025-04-30T23:59:59+09:00`
start_at_from required	string	Start at from	`2025-04-01T00:00:00+09:00`
bucket_id required	string	Bucket ID	`3d036efe-f576-48b0-8375-6d3704a95b63`
state optional	string	State	`SUCCESS`
limit optional	integer	Limit	`20`
offset optional	integer	Offset	`0`

Responses

Name	Description	Example
id	Archiving History ID	EXE-8f35b491-a060-453b-b825-e78440ca46de
archiving_id	Archiving ID	SCH-02d48456-0f35-47e2-8056-b00e09366cac
state	State	SUCCESS
archiving_policy_id	Archiving Policy ID	SCH-02d48456-0f35-47e2-8056-b00e09366cac
start_at	Start at	2025-04-01T00:00:00+09:00
end_at	End at	2025-04-30T23:59:59+09:00

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.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
start_at_to required	string	Start at to	`2025-04-30T23:59:59+09:00`
start_at_from required	string	Start at from	`2025-04-01T00:00:00+09:00`
bucket_id required	string	Bucket ID	`3d036efe-f576-48b0-8375-6d3704a95b63`
state optional	string	State	`SUCCESS`
limit optional	integer	Limit	`20`
offset optional	integer	Offset	`0`

Responses

Name	Description	Example
id	Archiving History ID	EXE-8f35b491-a060-453b-b825-e78440ca46de
archiving_id	Archiving ID	SCH-02d48456-0f35-47e2-8056-b00e09366cac
state	State	SUCCESS
archiving_policy_id	Archiving Policy ID	SCH-02d48456-0f35-47e2-8056-b00e09366cac
start_at	Start at	2025-04-01T00:00:00+09:00
end_at	End at	2025-04-30T23:59:59+09:00

1.9 - ListArchivingPolicies

1.9.1 - 1.1

scpcli archivestorage archiving policy list
--bucket_id <value>

Description

List archiving policies

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
bucket_id required	string	Bucket ID	`138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`

Responses

Name	Description	Example
id	Archiving Policy ID	SCH-XXXXXXX
object_lifecycle	Object LifeCycle	1
object_path	Object Path	/
state	Archiving Policy State	ACTIVE

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.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
bucket_id required	string	Bucket ID	`138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`

Responses

Name	Description	Example
id	Archiving Policy ID	SCH-XXXXXXX
object_lifecycle	Object LifeCycle	1
object_path	Object Path	/
state	Archiving Policy State	ACTIVE

1.10 - ListBucketObjects

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)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
bucket_id required	string	Bucket ID	`138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`
marker optional	string	Marker	`TODO.txt`
object_path optional	string	Object Path	`/`
object_name optional	string	Object Name	`hello/TODO.txt`
object_type optional	string	Object Type	`FILE`
limit optional	integer	Limit	`20`

Responses

Name	Description	Example
object_name	Object Name	hello/TODO.txt
object_type	Object Type	FILE
object_size	Object Size	3581
modified_at	Modified AT	2025-04-09T05:54:46.244000+00:00

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.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
bucket_id required	string	Bucket ID	`138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`
marker optional	string	Marker	`TODO.txt`
object_path optional	string	Object Path	`/`
object_name optional	string	Object Name	`hello/TODO.txt`
object_type optional	string	Object Type	`FILE`
limit optional	integer	Limit	`20`

Responses

Name	Description	Example
object_name	Object Name	hello/TODO.txt
object_type	Object Type	FILE
object_size	Object Size	3581
modified_at	Modified AT	2025-04-09T05:54:46.244000+00:00

1.11 - ListBucketObjectVersions

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)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
bucket_id required	string	Bucket ID	`138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`
object_path required	string	Object Path	`hello/my_file.txt`
offset optional	integer	Offset	`0`
limit optional	integer	Limit	`20`

Responses

Name	Description	Example
object_path	Object Path	hello/my_file.txt
object_version_id	Object Version Id	Oc9nEYWV.6VjzsIMXFZWM1zL8HcYvKl
latest	Is Latest version of Object	True
modified_at	Modified AT	2025-04-09T05:54:46.244000+00:00
etag	ETag	4f6094f1e0619a6504efcb5e69e63bec
size	Size	20

1.12 - ListBuckets

1.12.1 - 1.1

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

Description

List Buckets

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
name optional	string	Bucket name	`astest`
limit optional	integer	Limit	`20`

Responses

Name	Description	Example
id	Bucket ID	138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
name	Bucket name	astest

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.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
name optional	string	Bucket name	`astest`
limit optional	integer	Limit	`20`

Responses

Name	Description	Example
id	Bucket ID	138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
name	Bucket name	astest

1.13 - ListRecoveryHistories

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)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
start_at_to required	string	Start at to	`2025-04-30T23:59:59+09:00`
start_at_from required	string	Start at from	`2025-04-01T00:00:00+09:00`
bucket_id required	string	Bucket ID	`7d8d8c2b-d02a-421e-a6e3-5b981bfb507f`
state optional	string	State	`SUCCESS`
limit optional	integer	Limit	`20`
offset optional	integer	Offset	`0`

Responses

Name	Description	Example
id	Recovery History ID	EXE-9df439a5-9e6d-46a4-806e-1e9991520763
recovery_id	Recovery ID	ARC-f9eab563-312b-4bbf-a4bf-d377448d66b5
state	State	SUCCESS
recovery_target_bucket_name	Recovery Target Bucket NAME	test-obs-bucket
start_at	Start at	2025-04-01T00:00:00+09:00
end_at	End at	2025-04-30T23:59:59+09:00

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.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
start_at_to required	string	Start at to	`2025-04-30T23:59:59+09:00`
start_at_from required	string	Start at from	`2025-04-01T00:00:00+09:00`
bucket_id required	string	Bucket ID	`7d8d8c2b-d02a-421e-a6e3-5b981bfb507f`
state optional	string	State	`SUCCESS`
limit optional	integer	Limit	`20`
offset optional	integer	Offset	`0`

Responses

Name	Description	Example
id	Recovery History ID	EXE-9df439a5-9e6d-46a4-806e-1e9991520763
recovery_id	Recovery ID	ARC-f9eab563-312b-4bbf-a4bf-d377448d66b5
state	State	SUCCESS
recovery_target_bucket_name	Recovery Target Bucket NAME	test-obs-bucket
start_at	Start at	2025-04-01T00:00:00+09:00
end_at	End at	2025-04-30T23:59:59+09:00

1.14 - RecoverObjects

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)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
bucket_id required	string	Bucket ID	`138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`
overwrite required	boolean	Overwrite	`True`
recovery_infos required	array	Object Recovery Info List	`'{"source_object_path": "/", "object_type": "FILE"}'`
recovery_target_bucket_name required	string	Recovery Target Bucket Name	`obs-bucket-name`

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.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
bucket_id required	string	Bucket ID	`138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`
overwrite required	boolean	Overwrite	`True`
recovery_infos required	array	Object Recovery Info List	`'{"source_object_path": "/", "object_type": "FILE"}'`
recovery_target_bucket_name required	string	Recovery Target Bucket Name	`obs-bucket-name`

1.15 - RecoverObjectVersions

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)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
bucket_id required	string	Bucket ID	`138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`
overwrite required	boolean	Overwrite	`True`
source_object_version required	string	Recovery Source Object Version	`Oc9nEYWV.6VjzsIMXFZWM1zL8HcYvKl`
source_object_path required	string	Recovery Source Object Path	`/`
recovery_target_bucket_name required	string	Recovery Target Bucket Name	`obs-bucket-name`

1.16 - SetArchivingPolicy

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)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
archiving_policy_id required	string	Archiving Policy ID	`SCH-XXXXXXX`
bucket_id required	string	Bucket ID	`138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`
object_lifecycle required	string	Object LifeCycle	`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.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
archiving_policy_id required	string	Archiving Policy ID	`SCH-XXXXXXX`
bucket_id required	string	Bucket ID	`138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`
object_lifecycle required	string	Object LifeCycle	`1`

1.17 - SetArchivingPolicyState

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)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
archiving_policy_id required	string	Archiving Policy ID	`SCH-XXXXXXX`
bucket_id required	string	Bucket ID	`138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`
state required	string	Archiving Policy State	`ACTIVE`

1.18 - SetBucketEncryption

1.18.1 - 1.1

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

Description

Set a specific bucket encryption

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
bucket_id required	string	Bucket ID	`138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`
enabled required	boolean	Encryption Enabled	`True`

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.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
bucket_id required	string	Bucket ID	`138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`
enabled required	boolean	Encryption Enabled	`True`

1.19 - SetBucketVersioning

1.19.1 - 1.1

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

Description

set a specific bucket versioning

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
bucket_id required	string	Bucket ID	`138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`
enabled required	boolean	Versioning Enabled	`True`

1.20 - ShowArchivingHistory

1.20.1 - 1.1

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

Description

Show an archiving history

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
bucket_id required	string	Bucket ID	`3d036efe-f576-48b0-8375-6d3704a95b63`
id required	string	Archiving History ID	`EXE-8f35b491-a060-453b-b825-e78440ca46de`

Responses

Name	Description	Example
source_object_path	Source Object Path	example_source_object_path/
usage	Usage	1024
total_object_count	Total Object Count	100
archiving_object_count	Archiving Object Count	50
archiving_rate	Archiving Rate	100

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.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
bucket_id required	string	Bucket ID	`3d036efe-f576-48b0-8375-6d3704a95b63`
id required	string	Archiving History ID	`EXE-8f35b491-a060-453b-b825-e78440ca46de`

Responses

Name	Description	Example
source_object_path	Source Object Path	example_source_object_path/
usage	Usage	1024
total_object_count	Total Object Count	100
archiving_object_count	Archiving Object Count	50
archiving_rate	Archiving Rate	100

1.21 - ShowArchivingPolicy

1.21.1 - 1.1

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

Description

Show an archivingPolicy

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
archiving_policy_id required	string	Archiving Policy ID	`SCH-XXXXXXX`
bucket_id required	string	Bucket ID	`138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`

Responses

Name	Description	Example
id	Archiving Policy ID	SCH-XXXXXXX
bucket_id	Bucket ID	138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
archiving_source	Archiving Source
object_lifecycle	Object LifeCycle	1
state	Archiving Policy State	ACTIVE

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.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
archiving_policy_id required	string	Archiving Policy ID	`SCH-XXXXXXX`
bucket_id required	string	Bucket ID	`138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`

Responses

Name	Description	Example
id	Archiving Policy ID	SCH-XXXXXXX
bucket_id	Bucket ID	138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
archiving_source	Archiving Source
object_lifecycle	Object LifeCycle	1
state	Archiving Policy State	ACTIVE

1.22 - ShowBucket

1.22.1 - 1.1

scpcli archivestorage bucket show
--bucket_id <value>

Description

Show a specific bucket

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
bucket_id required	string	Bucket ID	`138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`

Responses

Name	Description	Example
id	Bucket ID	138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
name	Bucket name	astest
state	Bucket state	ACTIVE
usage	Bucket usage	10
archiving_source_bucket_name	Archiving source bucket name	obstest

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.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
bucket_id required	string	Bucket ID	`138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`

Responses

Name	Description	Example
id	Bucket ID	138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
name	Bucket name	astest
state	Bucket state	ACTIVE
usage	Bucket usage	10
archiving_source_bucket_name	Archiving source bucket name	obstest

1.23 - ShowBucketEncryption

1.23.1 - 1.1

scpcli archivestorage bucket encryption show
--bucket_id <value>

Description

Show a specific bucket encryption

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
bucket_id required	string	Bucket ID	`138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`

Responses

Name	Description	Example
id	Bucket ID	138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
enabled	Encryption Enabled	True

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.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
bucket_id required	string	Bucket ID	`138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`

Responses

Name	Description	Example
id	Bucket ID	138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
enabled	Encryption Enabled	True

1.24 - ShowBucketVersioning

1.24.1 - 1.1

scpcli archivestorage bucket versioning show
--bucket_id <value>

Description

show a specific bucket versioning

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
bucket_id required	string	Bucket ID	`138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2`

Responses

Name	Description	Example
id	Bucket ID	138c2-fc8c2-9a449-dbfa86-81f8f-1d78e2
enabled	Version Enabled	True

1.25 - ShowRecoveryHistory

1.25.1 - 1.1

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

Description

Show a recovery history

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
bucket_id required	string	Bucket ID	`7d8d8c2b-d02a-421e-a6e3-5b981bfb507f`
id required	string	Recovery History ID	`EXE-9df439a5-9e6d-46a4-806e-1e9991520763`

Responses

Name	Description	Example
source_object_path	Source Object Path	example_source_object_path/
usage	Usage	1024
total_object_count	Total Object Count	100
recovery_object_count	Recovery Object Count	50
recovery_rate	Recovery Rate	50

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.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
bucket_id required	string	Bucket ID	`7d8d8c2b-d02a-421e-a6e3-5b981bfb507f`
id required	string	Recovery History ID	`EXE-9df439a5-9e6d-46a4-806e-1e9991520763`

Responses

Name	Description	Example
source_object_path	Source Object Path	example_source_object_path/
usage	Usage	1024
total_object_count	Total Object Count	100
recovery_object_count	Recovery Object Count	50
recovery_rate	Recovery Rate	50