Data stored in Object Storage is automatically transferred to Archive Storage for retention and can be easily restored when needed.
This is the multi-page printable view of this section. Click here to print.
Archive Storage
- 1: Overview
- 1.1: ServiceWatch Metrics
- 2: How-to guides
- 3: API Reference
- 4: CLI Reference
- 5: Release Note
1 - Overview
Service Overview
Archive Storage is a storage service suitable for long-term retention of large amounts of data. The user can set a schedule to automatically move infrequently accessed data stored in Object Storage to Archive Storage, enabling efficient storage configuration and cost management. Additionally, upon user request, data stored in Archive Storage can be restored to Object Storage for use.
Features
Free Capacity Usage: When you create a bucket in Archive Storage, the bucket automatically expands or contracts based on the user’s data archiving and deletion. There is no cost for creating a storage bucket; you are only charged for storage usage.
Stable Data Recovery: Data that has been stored long-term can be searched and reliably recovered within three hours. During data recovery, select the target file and the Object Storage bucket where you want to store the data to recover it.
Cost Efficiency: By configuring Object Storage and Archive Storage efficiently according to the purpose and frequency of data usage, you can store and manage data at a reasonable cost.
Convenient Use: You can conveniently use features such as creating buckets, setting archiving schedules, and data recovery in the Samsung Cloud Platform Console. After migrating data for all files in Object Storage, you can apply a source deletion policy.
Configuration diagram
Provided features
Archive Storage provides the following features.
- Archiving Plan Configuration: Set a schedule to perform Archiving on all files in the Object Storage bucket.
- Data Recovery: You can recover to the target Object Storage bucket and folder using folders or files stored in Archive Storage.
- Archiving status monitoring: You can check the Archiving status (success, cancelled, failed, in progress, pending, skipped).
- Recovery status monitoring: You can view the recovery status (success, canceled, failed, in progress, pending).
- Encryption: When encryption is set to enabled, encryption is provided via the SSE‑S3 method.
- Version Management: You can manage archived files by version and restore a selected version.
- ServiceWatch Service Integration: You can monitor data using the ServiceWatch service.
Component
Authentication key
To create and access the Archive Storage service in the Samsung Cloud Platform Console, an authentication key is required. Therefore, to use Archive Storage, you must create an authentication key.
Bucket
A bucket is the top-level folder, and all folders and files reside under the bucket. When you create an Archive Storage service in the Samsung Cloud Platform Console, a bucket is created, and you can then upload folders or files.
The bucket name creation rules are as follows.
- Bucket names must be at least 3 characters and at most 63 characters.
- Bucket names can only be composed of lowercase English letters, numbers, periods
., and hyphens-. - Bucket names must start with a lowercase letter or a digit.
- Bucket names must not contain two consecutive periods.
- Bucket names cannot end with a period or hyphen.
- Bucket names cannot have a period and a hyphen adjacent to each other.
- Bucket names do not use the IP address format (e.g., 192.168.x.x).
- The bucket name cannot be admin.
- Bucket names must be unique within an Account/Region.
- The bucket name you previously used will be available after 1 hour.
| Example of a valid bucket name | Example of an invalid bucket name |
|---|---|
The following bucket names can be used
| The following bucket names cannot be used
|
folder
A folder (Folder) is used to logically group files.
The folder naming rules are as follows.
- Folder names can consist of Korean characters, English letters, numbers, and special characters.
- The special characters that cannot be entered are listed below.
| Special characters that cannot be used in folder names |
|---|
|
File
File (File) refers to data stored in Archive Storage and is the same as a regular file.
The filename generation rules are as follows.
- Filenames can consist of Korean characters, English letters, numbers, and special characters.
- The special characters that cannot be entered are listed below.
| Special characters that cannot be used in file names |
|---|
|
Folder names and file names are separated by slash /. The following are examples of valid folder and file names.
| Example of mixed use of folder names and file names |
|---|
|
/), must be within 1,024 bytes (based on UTF-8 encoding).Constraints
The limitations of Archive Storage are as follows.
| Category | description |
|---|---|
| Number of creatable Archive Storage services | 1000 or fewer |
| File name length (including path) | up to 1,024 Bytes |
Preceding Service
This is a list of services that must be pre‑configured before creating the service. Please refer to the guide provided for each service for details and prepare in advance.
| Service Category | Service | Detailed description |
|---|---|---|
| Storage | Object Storage | Object storage that simplifies data storage and retrieval |
1.1 - ServiceWatch Metrics
Archive Storage sends metrics to ServiceWatch. The metrics provided by default monitoring are data collected at 5‑minute intervals.
Basic Metrics
The following are the basic metrics for the Archive Storage namespace.
The indicators whose names are shown in bold below are the key indicators selected from the basic metrics provided by Archive Storage. Key metrics are used to configure service dashboards that are automatically generated for each service in ServiceWatch.
Each metric indicates, via the user guide, which statistical value is meaningful when viewing that metric, and among the meaningful statistics, the values shown in bold are the primary statistics. In the service dashboard, you can view key metrics using these primary statistical values.
| Performance items | Detailed description | unit | Meaningful statistics |
|---|---|---|---|
| object_count | Number of objects stored in the bucket | Count |
|
| object_byte | Amount of data stored in the bucket | Bytes |
|
2 - How-to guides
Users can create a service by entering the required information for Archive Storage and selecting detailed options through the Samsung Cloud Platform Console.
Create authentication key
To create and use the Archive Storage service in the Samsung Cloud Platform Console, you need to generate an authentication key in advance.
You can generate an authentication key at My menu > My Info. > Authentication Key Management > Create Authentication Key. For more information, refer to IAM > Create Authentication Key.
- The authentication key is used not only for Archive Storage but also for authentication in OpenAPI and CLI.
- You can generate up to two authentication keys.
- If the authentication key expires, access to the Archive Storage service will be restricted. To ensure smooth service usage, check the key’s expiration period in advance.
- If you disable the authentication key, access to the Archive Storage service will be restricted.
Create Archive Storage
You can create and use the Archive Storage service in the Samsung Cloud Platform Console.
To create Archive Storage, follow these steps.
- Click the All Services > Storage > Archive Storage menu. Navigate to the Service Home page of Archive Storage.
- On the Service Home page, click the Create Archive Storage button. You will be taken to the Create Archive Storage page.
- Archive Storage creation page, enter the information required to create the service, and select detailed options.
Category Required statusDetailed description Bucket name Required Bucket name for performing archiving - must start with a lowercase letter or digit and use lowercase letters, digits, dash
-, period.to enter 3~63 characters
- period
.cannot appear consecutively two or more times
- period
.and dash-cannot be adjacent
- period
.or dash-cannot be used to terminate
- IP address format not allowed
- admin name not allowed
- cannot use a bucket name already in use in the same region within the Samsung Cloud Platform Console
- For more details about buckets, see Bucket Naming Rules for reference
Table. Archive Storage service information input fields - must start with a lowercase letter or digit and use lowercase letters, digits, dash
- Summary Check the detailed information and estimated billing amount created in the panel, and click the Create button.
- Once creation is complete, check the created resources on the Archive Storage List page.
- After creating the bucket, configure encryption and versioning for secure data management.
- Encryption and versioning can be configured on the Archive Storage Details page. For more information, see Archive Storage Encryption Settings and Version Management Settings.
View Archive Storage details
Archive Storage Details page consists of Detail Information, Folder List, Archiving History, Recovery History, and Tag tabs.
Follow these steps to view detailed information about the Archive Storage service.
- Click the All Services > Storage > Archive Storage menu. Navigate to the Service Home page of Archive Storage.
- On the Service Home page, click the Archive Storage menu. You will be taken to the Archive Storage List page.
- Archive Storage List page, click the resource to view detailed information. You will be taken to the Archive Storage Details page.
- Archive Storage Details page displays status information and additional feature information, and consists of Details, Folder List, Archiving History, Recovery History, and Tags tabs.
Category Detailed description Archive Storage status Archive Storage status information - Active: available
- Error: abnormal state while being terminated
- Deleting: service termination in progress
Service termination Button to cancel the service Table. Archive Storage status information and additional features
- Archive Storage Details page displays status information and additional feature information, and consists of Details, Folder List, Archiving History, Recovery History, and Tags tabs.
Detailed information
Detailed Information tab allows you to view the resource’s detailed information and edit it if needed.
| Category | Detailed description |
|---|---|
| Service | Service group |
| Resource Type | Resource Type |
| SRN | Unique resource ID in Samsung Cloud Platform |
| Resource name | Resource Name
|
| Resource ID | Service’s unique resource ID |
| Bucket name | User-created bucket name |
| Usage | Total data usage of the bucket |
| Encryption | Encryption usage information
|
| Version control | Version management usage information
|
| Archiving Policy | Check the configured archiving target and policy actions
|
| Archiving target | Object Storage bucket for archiving |
| Policy work | Archiving policy list
|
- Archiving target can be set only once initially. After setting, it cannot be modified.
- The policy operation performs archiving on all versioned files in Object Storage.
- The archiving policy can only be modified and cannot be deleted.
- The archiving policy is executed once daily, based on the time of addition.
Folder list
Folder List tab allows you to view the list and size of folders that have been archived.
| Category | Detailed description |
|---|---|
| Name | Name of the file or folder that was archived
|
| size | Size of archived files or folders |
| Modification date and time | Last modified date and time of a file or folder |
| More button | Manage selected files or folders
|
Archiving History
Archiving History tab allows you to view the list of archiving performed over a specific period.
| Category | Detailed description |
|---|---|
| Query period | Select the period to view the archiving history
|
| status | Select Archiving status
|
| Policy ID | Archiving policy ID
|
| Execution time | Archiving start time |
| Completion date and time | Archiving completion time |
| status | Archiving status information |
| Cancel | Cancel Archiving Task
|
| Search area |
- Query Period: Select the period to view the Archiving history
- You can query up to a maximum of 90 days
- Status: Select the Archiving status
- All, In Progress, Success, Failure, Canceled, Pending, Skipped can be selected
Recovery History
In the Recovery History tab, you can view the list of Archives that performed recovery operations over a specific period.
| Category | Detailed description |
|---|---|
| Query period | Select the period to view the recovery history
|
| status | Select recovery status
|
| Recovery target | Recovery target Object Storage name
|
| Recovery date and time | Recovery start time |
| Completion Time | Recovery Completion Time |
| status | Recovery status information |
| Cancel recovery operation | Cancel recovery operation
|
Tag
In the Tag tab, you can view the resource’s tag information, and add, modify, or delete it.
| Category | Detailed description |
|---|---|
| Tag list | Tag list
|
Archive Storage Encryption Configuration
You can configure the bucket to encrypt the data stored in it. After enabling bucket encryption, the encryption settings are applied to uploaded data. When encryption is used, the SSE‑S3 encryption key method and the AES256 encryption algorithm are applied.
Archive Storage’s bucket encryption can provide two options (SSE-S3/SSE-KMS).
- SSE-S3 is server-side encryption (SSE-S3) that uses Amazon S3 managed keys.
- SSE-KMS is server-side encryption (SSE-KMS) that uses Key Management Service (KMS) keys.
- In this service, server-side encryption using Amazon S3 managed keys (SSE‑S3) is released as the default method, and server-side encryption using Key Management Service (KMS) keys (SSE‑KMS) will be offered later according to the service roadmap.
If there is data that was stored before the bucket encryption was configured, the encryption setting will not be applied.
- If you re‑upload the file, the encryption will be applied.
- To enable encryption for existing data, you need to re‑upload it.
To set up encryption, follow these steps.
- Click the All Services > Storage > Archive Storage menu. Navigate to the Service Home page of Archive Storage.
- On the Service Home page, click the Archive Storage menu. You will be taken to the Archive Storage List page.
- On the Archive Storage List page, click the resource (bucket) to use for encryption. You will be taken to the Archive Storage Details page.
- On the Archive Storage Details page, verify that Encryption is Not Used, then click the Edit button. The Edit Encryption popup opens.
- After checking the use of encryption, click the Confirm button.
Archive Storage Terminate
To cancel Archive Storage, follow these steps.
- Click the All Services > Storage > Archive Storage menu. Navigate to the Service Home page of Archive Storage.
- On the Service Home page, click the Archive Storage menu. You will be taken to the Archive Storage List page.
- On the Archive Storage list page, select the resource to cancel, and click the Cancel Service button.
- After termination is complete, verify on the Archive Storage List page that the resource has been terminated.
2.1 - Manage Archiving Policy
You can add, modify, or delete archiving policies.
Add Archiving Policy
To add an Archiving policy, follow these steps.
- Click the All Services > Storage > Archive Storage menu. Navigate to the Service Home page of Archive Storage.
- On the Service Home page, click the Archive Storage menu. You will be taken to the Archive Storage List page.
- On the Archive Storage List page, click the resource to view detailed information. You will be taken to the Archive Storage Details page.
- Click the Add button of Policy Task. The Archiving Policy Add popup opens.
- After entering the Archiving policy information, click the Confirm button.
Category Detailed description Archiving target Select the Object Storage bucket for archiving - Cannot be modified after initial configuration
- Only buckets within the same region can be added
- Buckets used in policies of other Arcvhie Storage cannot be selected
target file Select files for archiving - Only All can be selected
Policy work When selected, archiving is performed on all versioned objects in Object Storage - When Archive Storage version management is enabled: each version is managed separately
- When Archive Storage version management is disabled: managed by overwriting the current version
execution time Enter the archiving execution point - Enter a number between 1 and 3,650
Table. Archiving policy addition popup items
- Archiving target can be set only once initially. After setting, it cannot be modified.
- The policy operation performs archiving on all versioned files in Object Storage.
- The archiving policy can only be modified and cannot be deleted.
- The archiving policy is executed once daily, based on the time of addition.
- Cannot set an additional policy when the target files for the Archiving policy are set to All.
Modify Archiving Policy
To modify the Archiving policy, follow these steps.
- Click the All Services > Storage > Archive Storage menu. Navigate to the Service Home page of Archive Storage.
- On the Service Home page, click the Archive Storage menu. You will be taken to the Archive Storage List page.
- On the Archive Storage List page, click the resource to view its details. You will be taken to the Archive Storage Details page.
- Policy Actions In the list, select the policy you want to edit, then click the More > Add button on the right. The Edit Archiving Policy popup opens.
- After editing the Archiving policy information, click the Confirm button.
Delete Archiving Policy
To delete the Archiving policy, follow these steps.
- Click the All Services > Storage > Archive Storage menu. Navigate to the Service Home page of Archive Storage.
- On the Service Home page, click the Archive Storage menu. Go to the Archive Storage List page.
- Archive Storage List page: Click the resource to view detailed information. You will be taken to the Archive Storage Details page.
- From the Policy actions list, select the policy you want to delete, then click the More > Delete button on the right. The Delete Archiving Policy popup opens.
- After reviewing the Archiving policy information, click the Confirm button.
–>
Change Archiving Policy Status
You can enable or disable the Archiving policy to control whether it is executed.
To change the Archiving policy status, follow these steps.
- Click the All Services > Storage > Archive Storage menu. Navigate to the Service Home page of Archive Storage.
- On the Service Home page, click the Archive Storage menu. You will be taken to the Archive Storage List page.
- On the Archive Storage List page, click the resource whose Archiving policy status you want to change. You will be taken to the Archive Storage Details page.
- From the Policy Actions list, click the More > Activate or More > Deactivate button for the policy whose status you want to change. A popup notifying the change of the Archiving policy status will open.
- Activation: Perform archiving according to the archiving policy.
- Disable: Stops performing archiving.
- Click the Confirm button. The status of the Archiving policy will be changed.
Cancel archiving operation
To cancel archiving, follow these steps.
- Click the All Services > Storage > Archive Storage menu. Navigate to the Service Home page of Archive Storage.
- On the Service Home page, click the Archive Storage menu. You will be taken to the Archive Storage list page.
- On the Archive Storage List page, click the resource to cancel the Archiving operation. Then go to the Archive Storage Details page.
- Click the Archive History tab.
- Check whether the status of the Archiving policy to cancel the job in the Archiving history list is Pending or In Progress.
- Click the Cancel button. A cancel confirmation popup will open.
- Click the Confirm button. The Archiving operation will be canceled.
Understanding how Archiving works
The archiving behavior varies by archiving target as follows.
| Archiving target | Detailed description |
|---|---|
| previous version/current version file | Depends on whether versioning is enabled for Archive Storage
|
| File containing Delete Marker version | Delete Marker versions cannot be archived
|
| Empty folder | Folder cannot be created in Archive Storage |
| Folder containing files | Whether the folder is an Object determines whether the folder is deleted from Object Storage after archiving
|
| When there is no target file | Archiving schedule as is
|
| If the target Object Storage bucket is terminated |
|
- Archiving is performed based on the Etag value of the Object Storage file.
- After archiving, Version ID and Modification Timestamp are changed. However, the Etag value remains the same.
2.2 - Use Version Management
By enabling versioning on a bucket, you can manage all Object Storage versions in Archive Storage.
Using version control, you can view a file’s version list and select a previous version from the list to restore it.
Setting up version control
To configure the version control feature, follow these steps.
- Click the All Services > Storage > Archive Storage menu. Navigate to the Service Home page of Archive Storage.
- On the Service Home page, click the Archive Storage menu. You will be taken to the Archive Storage list page.
- On the Archive Storage List page, click the resource to use the version control feature. You will be taken to the Archive Storage Details page.
- On the Archive Storage Details page, verify that Version Management is Not Used, then click the Edit button.Version Management Edit popup opens.
- After checking Enabled for version management, click the Confirm button. The Version Management on the Archive Storage Details page will be changed to Enabled.
- When you configure version control for the first time, it may take some time for changes to be applied.
- The time required varies depending on the size of the bucket, and versioning may not be applied until the configuration is completed.
Check version list
You can view and manage the list of file versions.
To view and manage the file’s version list, follow these steps.
- Click the All Services > Storage > Archive Storage menu. Navigate to the Service Home page of Archive Storage.
- On the Service Home page, click the Archive Storage menu. You will be taken to the Archive Storage list page.
- Archive Storage List page, click the resource to view the version list. Archive Storage Details page will be opened.
- On the Archive Storage Details page, click the Folder List tab.
- Click the More > Version Management button of the file whose version list you want to view. The version list popup will open.
| Category | Detailed description |
|---|---|
| filename | File name under version control |
| Modification date | File modification date and time |
| Version ID | Version ID assigned to each individual file
|
| Etag | Object that can identify a file, specific version |
| Size | Version file size |
| More | Delete or restore the version
|
From the moment version control is configured, you can view and manage the version IDs of archived files.
- Before configuring version control, archived files: the version ID is shown as null(-).
- After configuring version control, the archived file: a version file is added, and a unique version ID is generated and assigned.
Delete version file
To delete unused version files, follow the steps below.
- Click the All Services > Storage > Archive Storage menu. Navigate to the Service Home page of Archive Storage.
- On the Service Home page, click the Archive Storage menu. You will be taken to the Archive Storage list page.
- Archive Storage List page, click the resource to view the version list. You will be taken to the Archive Storage Details page.
- On the Archive Storage Details page, click the Folder List tab.
- Click the More > Version Control button of the file whose version file you want to delete. The version list popup will open.
- Click the More > Delete button for the version file you want to delete. The version file will be removed from the version list.
- After selecting all version files to delete, click the Delete button at the top of the list to delete them all at once.
2.3 - Archive Recovery
Archive Recovery
- Recovery can be performed on a per-file basis, and the data stored in Archive Storage is not deleted after recovery.
- When restoring an archive file, select the bucket and folder in Object Storage and restore to that location. Before starting the restoration, first verify the Object Storage you intend to restore.
Recover from folder list
If you are not using the version control feature, you can recover by selecting the Archive file from the folder list.
To check and recover the archive file, follow these steps.
- Click the All Services > Storage > Archive Storage menu. Navigate to the Service Home page of Archive Storage.
- On the Service Home page, click the Archive Storage menu. You will be taken to the Archive Storage List page.
- On the Archive Storage List page, click the resource to view detailed information. You will be taken to the Archive Storage Details page.
- Click the Folder List tab.
- Select the folder or file name to restore from the folder list. The Delete button and Restore button appear at the top of the list.
- Click the Restore button. The Archive Restore popup opens.
- After selecting the recovery information, click the Confirm button.
Category Detailed description Bucket name Object Storage bucket name Original location Original file or folder location Recovery target Select the bucket to recover Overwrite Select whether to use the overwrite function - When selecting a bucket in Object Storage with versioning enabled as the recovery target, using the overwrite function stores the existing file with the same name as a previous version
Table. Archive recovery popup items
- Recovery may fail due to character length restrictions on files and folders. For the character length restrictions on files and folders, see the File name creation rules and Folder name creation rules.
- After a recovery failure, if you perform the recovery again using the overwrite function, you may be charged duplicate fees.
Recover from version list
When using the version control feature, you can check a file’s version and restore it to the desired version.
- To view and restore a file’s version, set the version control feature to enabled..
- Refer to Configure Version Management for how to configure the versioning feature.
To restore an Archive file using a version file, follow these steps.
- Click the All Services > Storage > Archive Storage menu. Navigate to the Service Home page of Archive Storage.
- On the Service Home page, click the Archive Storage menu. You will be taken to the Archive Storage List page.
- Archive Storage List page, click the resource to view detailed information. You will be taken to the Archive Storage Details page.
- Click the Folder List tab.
- In the folder list, click the More > Version Management button for the file whose version list you want to view. The version list popup will open.
- In the version list, click the More > Restore button for the version file you want to recover. The Archive Restore popup window will open.
- After selecting the recovery information, click the Confirm button.
Category Detailed description Bucket name Object Storage bucket name Original location Original file or folder location Version list Modification timestamp, version ID, Etag, and size information of the version to be restored Recovery target Select the bucket to recover Overwrite Select whether to use the overwrite function - When selecting a bucket in Object Storage with versioning enabled as the recovery target, using the overwrite function stores the existing file with the same name as a previous version
Table. Archive recovery popup items
- Recovery may fail due to character length limits on files and folders. For the character length limits on files and folders, see File Name Creation Rules and Folder Name Creation Rules.
- After a recovery failure, if you perform the recovery again using the overwrite function, you may be charged duplicate fees.
Cancel recovery operation
To cancel the recovery operation, follow these steps.
- Click the All Services > Storage > Archive Storage menu. Navigate to the Service Home page of Archive Storage.
- On the Service Home page, click the Archive Storage menu. You will be taken to the Archive Storage list page.
- On the Archive Storage List page, click the resource for which you want to cancel the recovery operation. You will be taken to the Archive Storage Details page.
- Click the Recovery History tab.
- Verify that the status of the recovery target to be canceled in the recovery history list is Pending or In Progress.
- Click the Cancel button. A confirmation popup for canceling the operation will open.
- Click the Confirm button. The recovery operation will be canceled.
Understanding archive recovery methods
The recovery methods according to the type of recovery are as follows.
| Recovery type | Status description |
|---|---|
| General recovery |
|
| If there are no files to recover (overwrite option not used) | Not shown in the status check list |
3 - API Reference
4 - CLI Reference
5 - Release Note
Archive Storage
- ServiceWatch service integration provision
- You can monitor data through the ServiceWatch service.
- You can manage archived folders or files by version.
- Users can view archived folders or files by version and select a desired version to delete or restore.
- We have launched the Archive Storage service.
- Data stored in Object Storage is automatically transferred to Archive Storage for retention and can be easily restored when needed.
