Archive Storage overview

Available in Classic and VPC

Archive Storage is a service on the NAVER Cloud Platform that allows you to store large volumes of data for long periods at a low cost. Archive Storage provides a CLI for container (bucket) and object management using the swift command, which is compatible with the OpenStack Swift CLI.

Common Archive Storage settings

This section describes how to install and authenticate the Archive Storage CLI, as well as the common commands and option formats.

installation

The Archive Storage CLI is used by installing the OpenStack Swift client. Install it using the following command, depending on your Python version.

The installation command for Python 3.9 or earlier is as follows:

pip install python-keystoneclient==3.17.0
pip install python-swiftclient==3.6.0

Installation commands for Python 3.10 or later are as follows:

pip install python-keystoneclient==5.1.0
pip install python-swiftclient==4.3.0

Note

For more information about the OpenStack Swift CLI, see the OpenStack Swift CLI documentation.

Certification

Archive StorageArchive Storage uses tokens obtained through authentication to access the service. The authentication command is as follows:

swift --os-auth-url https://kr.archive.ncloudstorage.com:5000/v3 --auth-version 3 \
      --os-username {access_key_id} --os-password {secret_key} \
      --os-user-domain-id {domain_id} --os-project-id {project_id} \
      auth

Note

For information on how to verify your access_key_id and secret_key, see API authentication key.
To obtain your project_id and domain_id, sign up for the Archive Storage service in the NAVER Cloud Platform console, then click the [Check API usage information] button in the Container Management menu.

If authentication is successful, the storage URL and authentication token are returned.

export OS_STORAGE_URL=https://kr.archive.ncloudstorage.com/v1/AUTH_{project_id}
export OS_AUTH_TOKEN={token}

By running the returned export commands to set OS_STORAGE_URL and OS_AUTH_TOKEN as environment variables, you can make service requests without having to re-authenticate.

export OS_STORAGE_URL=https://kr.archive.ncloudstorage.com/v1/AUTH_{project_id}
export OS_AUTH_TOKEN={token}

swift list

You can also enter values directly for the --os-storage-url and --os-auth-token options without declaring them as environment variables.

swift --os-storage-url https://kr.archive.ncloudstorage.com/v1/AUTH_{project_id} \
      --os-auth-token {token} \
      list

Note

We do not recommend the method of entering authentication credentials each time you request them using an authentication command, rather than storing the service authentication URL and token value as environment variables. This is because it requires performing authentication every time.

Syntax

Run swift using the following syntax.

swift <subcommand> [options]

Options

The following options are available across all swift subcommands:

Options	Type	Required	Description
`--os-storage-url`	String	Conditional	Service URL Enter along with `--os-auth-token`. If entering credentials manually, leave blank.
`--os-auth-token`	String	Conditional	Issued authentication token Enter along with `--os-storage-url`. If entering credentials manually, leave blank.
`--os-auth-url`	String	Conditional	Authentication URL Required when not entering `--os-storage-url` and `--os-auth-token` Korea Region: `https://kr.archive.ncloudstorage.com:5000/v3`
`--auth-version`	String	Conditional	Authentication API version Required when entering `--os-auth-url` `3`
`--os-username`	String	Conditional	API authentication key's access key ID Required when entering `--os-auth-url`. See Ncloud API.
`--os-password`	String	Conditional	API authentication key's secret key Required when entering `--os-auth-url`. See Ncloud API.
`--os-user-domain-id`	String	Conditional	Domain ID to which the user belongs Required when entering `--os-auth-url`. Check by clicking [Check API usage information] under the Archive Storage > Container Management menu in the console.
`--os-project-id`	String	Conditional	Project ID to which the user belongs Required when entering `--os-auth-url`. Check by clicking [Check API usage information] under the Archive Storage > Container Management menu in the console.

Archive Storage commands

The following subcommands are available under swift.

Commands	Description
auth	Output authentication environment variables.
post	Create a container (bucket) and change metadata.
upload	Upload a file or directory.
list	Get the list of containers (buckets) or objects.
stat	Get information about accounts, containers (buckets), or objects.
download	Download an object.
copy	Copy an object.
tempurl	Create a temporary URL to access an object.
delete	Delete a container (bucket) or object.
capabilities	Get cluster’s supported features and limits.

Archive Storage related resources

These resources provide additional context and support for the Archive Storage CLI.

Archive Storage CLI service guides
- Archive Storage user guide: Learn how to use Archive Storage in the NAVER Cloud Platform console.
- Archive Storage API guide: Learn how to call Archive Storage APIs.
- Archive Storage user environment guide: Explore VPC and Classic environments and supported services.
- Pricing and features: View pricing details and key capabilities.
- Latest announcements: Stay informed about Archive Storage updates and news.
- FAQs: Get answers to common Archive Storage questions.
- Contact Support: Get help if you can't find what you need in the CLI guide.