Ncloud Storage overview

Available in Classic and VPC

Ncloud Storage is an object storage service on the NAVER Cloud Platform that allows you to store and manage data on the internet. Ncloud Storage provides a CLI for managing buckets and objects using aws command, which is compatible with the Amazon S3 CLI.

Common Ncloud Storage settings

This section describes how to install and authenticate the Ncloud Storage CLI, as well as the commonly used commands and option formats.

installation

Ncloud Storage CLI is used by installing the AWS CLI. The installation command is as follows:

pip3 install awscli

Note

The pip3 command installs AWS CLI v1, and the examples in this guide are based on v1 output. For instructions on installing AWS CLI v2, see the AWS CLI Installation Guide.

Certification

The command to configure your credentials is as follows:

aws configure

After running the command, enter the following items in order.

AWS Access Key ID [None]: {access_key_id}
AWS Secret Access Key [None]: {secret_key}
Default region name [None]: kr
Default output format [None]: [Enter]

Note

For information on how to verify your access_key_id and secret_key, see API authentication key.
Ncloud Storage currently only supports the KR Region.
The supported output formats are json, text, table, yaml, and yaml-stream.

Syntax

Run aws using the following syntax.

aws s3 <subcommand> [options] --endpoint-url <endpoint-url>
aws s3api <subcommand> [options] --endpoint-url <endpoint-url>

Note

When using the CLI, you must specify the --endpoint-url option. The call domains for each Region are as follows:
- Region: Korea
- Region name: kr
- Call domain: https://kr.ncloudstorage.com
We plan to continuously expand the available Regions.

s3 is a high-level command that treats Ncloud Storage like a file system, while s3api is an API-level command that corresponds 1:1 with the Ncloud Storage API.

The command to view help is as follows:

aws help
aws <command> help
aws <command> <subcommand> help

Options

The following options are available across all aws subcommands:

Options	Type	Required	Description
`--endpoint-url`	String	Required	Endpoint URL to call the command `https://kr.ncloudstorage.com` Supports the KR Region only.
`--region`	String	Optional	Region `kr`
`--profile`	String	Optional	Profile name to use for credential and configuration files Default: `default` Applies settings stored in the profile—such as Region and output format—in addition to credentials.
`--no-sign-request`	Boolean	Optional	Disables request signing. Makes requests anonymously without loading credentials.
`--cli-input-json`, `--cli-input-yaml`	String	Optional	Enter command parameters in JSON or YAML format. Specify local file paths using the `file://` prefix. JSON and YAML cannot be specified simultaneously. Only API-level commands are supported.
`--generate-cli-skeleton`	String	Optional	Creates a parameter template without executing the command. `input` (default) \| `yaml-input` \| `output` Only API-level commands are supported.
`--cli-auto-prompt`	Boolean	Optional	Enables automatic option prompts. Interactively select and enter commands and options.
`--no-cli-auto-prompt`	Boolean	Optional	Disables automatic option prompts.
`--output`	String	Optional	Response result format `json` (default) \| `text` \| `table` \| `yaml` \| `yaml-stream`
`--query`	String	Optional	JMESPath query to use when filtering response results
`--color`	String	Optional	Whether to use output colors `on` \| `off` \| `auto` (default)
`--no-paginate`	Boolean	Optional	Disables automatic pagination. Retrieves only the first page of results.
`--no-cli-pager`	Boolean	Optional	Disables the CLI pager. Returns results to standard output without going through the pager.
`--ca-bundle`	String	Optional	Path to the CA certificate bundle used when validating SSL certificates
`--no-verify-ssl`	Boolean	Optional	Disables SSL certificate validation.
`--cli-connect-timeout`	Integer	Optional	Maximum connection time (second) Default: `60` If `0` is specified, operates in blocking mode without a timeout.
`--cli-read-timeout`	Integer	Optional	Maximum read time (second) Default: `60` If `0` is specified, operates in blocking mode without a timeout.
`--debug`	Boolean	Optional	Enables debug logging.

Ncloud Storage commands

The following subcommands are available under aws.

High-level

Using high-level commands, you can access and manage Ncloud Storage as if it were a file system. The relevant commands are as follows:

Commands	Description
mb	Create bucket.
ls	Get bucket and object.
cp	Copy object.
mv	Move object.
sync	Sync object.
presign	Create pre-signed object URL.
rm	Delete object.
rb	Delete bucket.

API-level

API-level commands correspond one-to-one with the Ncloud Storage API. The relevant commands are as follows:

Commands	Description
create-bucket	Create a bucket to store objects in Ncloud Storage.
list-buckets	Get the list of all buckets owned by the user.
head-bucket	Get the properties of a bucket created in Ncloud Storage.
get-bucket-location	Get the Region information of a bucket created in Ncloud Storage.
delete-bucket	Delete a bucket created in Ncloud Storage.
get-bucket-versioning	Get bucket versioning settings.
put-bucket-versioning	Set up versioning for a bucket.
get-bucket-encryption	Get the encryption method configured for a bucket.
put-bucket-encryption	Configure default server-side encryption (SSE) for a bucket.
delete-bucket-encryption	Delete the encryption settings configured for a bucket.
get-bucket-cors	Get the CORS rules configured for a bucket.
put-bucket-cors	Configure CORS rules for a bucket.
delete-bucket-cors	Delete CORS rules configured for a bucket.
get-bucket-lifecycle-configuration	Get lifecycle rules registered for a bucket.
put-bucket-lifecycle-configuration	Register a lifecycle rule for a bucket.
delete-bucket-lifecycle	Delete a lifecycle rule registered for a bucket.
get-object-lock-configuration	Get object lock settings configured for a bucket.
put-object-lock-configuration	Apply object lock settings to a bucket.
put-object	Save an object in Ncloud Storage.
get-object	Download an object stored in Ncloud Storage.
head-object	Get the metadata of an object stored in Ncloud Storage.
copy-object	Copy an object stored in Ncloud Storage.
get-object-attributes	Get attributes of an object stored in Ncloud Storage.
list-objects	Get the list of objects stored in a bucket.
list-objects-v2	Get the list of objects stored in a bucket.
list-object-versions	Get all version metadata for objects stored in a bucket that uses versioning.
delete-object	Delete an object stored in Ncloud Storage.
delete-objects	Delete multiple objects stored in Ncloud Storage simultaneously.
restore-object	Restore an object stored in the Deep Archive Class.
get-object-legal-hold	Get the legal hold status set on an object.
put-object-legal-hold	Set a legal hold on an object.
get-object-retention	Get retention information set on an object.
put-object-retention	Set retention on an object.
create-multipart-upload	Start a multipart upload and return an upload ID.
upload-part	Upload a part of a multipart upload.
upload-part-copy	Copy a large object stored in Ncloud Storage.
list-parts	Get the list of parts uploaded via a specific multipart upload.
list-multipart-uploads	Get the list of currently in-progress multipart uploads.
complete-multipart-upload	Combine the uploaded parts to create an object and complete the multipart upload.
abort-multipart-upload	Stop ongoing multipart upload.

Ncloud Storage related resources

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

Ncloud Storage CLI service guides
- Ncloud Storage user guide: Learn how to use Ncloud Storage in the NAVER Cloud Platform console.
- Ncloud Storage API guide: Learn how to call Ncloud Storage APIs.
- Ncloud 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 Ncloud Storage updates and news.
- FAQs: Get answers to common Ncloud Storage questions.
- Contact Support: Get help if you can't find what you need in the CLI guide.