Available in Classic and VPC
This guide describes how to set up the Ncloud Storage CLI, which is compatible with Amazon S3 CLI, and lists the available commands.
Initial settings
This section describes how to install and authenticate Ncloud Storage CLI.
CLI installation
The installation command is as follows:
pip3 install awscli
Ncloud Storage is optimized for awscli v2.
Authenticate
The following describes how to set the authentication information. Use the API authentication key created in Portal My Page > Manage account > Manage authentication key.
~$ aws configure
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]
Ncloud Storage currently only supports the KR Region.
Supported output formats are json, text, table, yaml, and yaml-stream.
Calling domain (endpoint)
The --endpoint-url option is required when using the CLI. The call domain is as follows:
| Region | Region name | Calling Domain |
|---|---|---|
| Korea | kr | https://kr.ncloudstorage.com |
We plan to continue to expand the Regions we offer.
Commands
The list of commands supported by Ncloud Storage CLI is as follows:
High-Level
Using high-level commands, you can access and manage Ncloud Storage as if it were a file system. The command is as follows:
| Commands | Description |
|---|---|
| cp | Copy object. |
| ls | Get bucket and object. |
| mb | Create bucket. |
| mv | Move object. |
| presign | Create pre-signed URL for object. |
| rb | Delete bucket. |
| rm | Delete object. |
| sync | Sync object. |
API-Level
The API-level commands are as follows:
| Commands | Description |
|---|---|
| abort-multipart-upload | Stop ongoing multipart upload. |
| complete-multipart-upload | Create an object by combining parts that have already been uploaded using multipart upload, and complete the multipart upload. |
| copy-object | Copy an object stored in Ncloud Storage. |
| create-bucket | Create a bucket to store objects in Ncloud Storage. |
| create-multipart-upload | Start a multipart upload to upload large objects and return the upload ID. |
| delete-bucket | Delete a bucket created in Ncloud Storage. |
| delete-bucket-lifecycle | Delete a lifecycle rule registered in a Ncloud Storage bucket. |
| delete-object | Delete an object stored in Ncloud Storage. |
| delete-objects | Delete multiple objects stored in Ncloud Storage at the same time. |
| get-bucket-encryption | Get the encryption method set in a Ncloud Storage bucket. |
| get-bucket-lifecycle-configuration | Get the lifecycle rule registered in a Ncloud Storage bucket. |
| get-bucket-location | Get the Region information of a bucket created in Ncloud Storage. |
| get-bucket-versioning | Get whether version control is enabled for a bucket created in Ncloud Storage. |
| get-object | Download an object stored in Ncloud Storage. |
| head-bucket | Get the properties of a bucket created in Ncloud Storage. |
| head-object | Get the metadata of an object stored in Ncloud Storage. |
| list-buckets | Get the list of all buckets owned by the user. |
| list-multipart-uploads | Get the list of ongoing multipart uploads. |
| list-objects | Get the list of objects stored in Ncloud Storage. |
| list-objects-v2 | Get the list of objects stored in Ncloud Storage. |
| list-object-versions | Get the metadata of all versions of an object stored in a bucket that uses version control. |
| list-parts | Get the list of parts uploaded through a specific multipart upload. |
| put-bucket-lifecycle-configuration | Register a lifecycle rule in a Ncloud Storage bucket. |
| put-bucket-versioning | Set up version control for a bucket created in Ncloud Storage. |
| put-object | Save an object in Ncloud Storage. |
| restore-object | Restore an object so that the object stored in the Deep Archive Class can be accessed. |
| upload-part | Upload a part of a multipart upload. |
| upload-part-copy | Copy a large object stored in Ncloud Storage. |
Command help
Run the following command to view help for best use of Ncloud Storage CLI.
aws help
aws <command> help
aws <command> <subcommand> help