Object Storage overview

Available in Classic and VPC

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

Common Object Storage settings

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

installation

To use the Object Storage CLI, install the AWS CLI. The installation command is as follows:

pip install awscli==1.15.85

Note

Since awscli versions 1.16.x and later do not support certain features, we recommend using version 1.15.x.
AWS CLI version 1.15.85 works with Python 3.8 or earlier.
For related resources, see the following:
- Documentation: awscli 1.15.85
- git: aws-cli 1.15.85

Certification

The command to configure your credentials is as follows:

aws configure

When you run the command, enter the following items in order.

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

Note

For access_key_id and secret_key, use the API authentication key created by referring to Ncloud API.
Servers assigned a role can use Object Storage commands without any additional authentication configuration. In this case, since the Metadata API’s Get authentication key API is used, timeouts may occur; you can extend the timeout using the following command.
```
export AWS_METADATA_SERVICE_TIMEOUT=10
```

Syntax

Run aws using the following syntax.

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

s3 is a high-level command optimized for file-level jobs, while s3api is an API-level command that corresponds one-to-one with the Object 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 for calling the command For Region-specific call domains, see the Object Storage API guide.
`--region`	String	Optional	Region Only the Korea Region is supported.
`--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.
`--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.
`--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.

Object Storage commands

The following subcommands are available under aws.

High-level

Commands related to s3 used for file-level jobs are as follows:

Commands	Description
mb	Create bucket.
ls	Get the list of buckets, folders, or objects.
cp	Upload, download, and copy an object.
sync	Sync between directories and buckets.
rm	Delete object.
rb	Delete bucket.

API-level

The following s3api commands correspond one-to-one with the Object Storage API.

Commands	Description
create-bucket	Create bucket.
list-buckets	Get bucket list.
delete-bucket	Delete bucket.
get-bucket-cors	Get bucket CORS rules.
put-bucket-cors	Configure bucket CORS rules.
put-object	Upload object.
get-object	Download object.
list-objects	Get object list.
put-object-acl	Configure object access control list.
delete-object	Delete object.
create-multipart-upload	Start a multipart upload.
upload-part	Upload a part of a multipart upload.
complete-multipart-upload	Complete multipart upload.
list-multipart-uploads	Get the list of multipart uploads in progress.
abort-multipart-upload	Stop a multipart upload.

Object Storage related resources

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

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