Ncloud Storageの概要

Classic/VPC環境で利用できます。

Ncloud Storageは、インターネット上でデータを保存および管理できる、NAVERクラウドプラットフォームのオブジェクトストレージサービスです。Ncloud Storageでは、バケットおよびオブジェクト管理機能に関する CLIを、Amazon S3 CLIと互換性のあるawsコマンドとして提供しています。

Ncloud Storageの共通設定

Ncloud Storage CLIの使用に必要なインストールと認証の方法、および共通して使用されるコマンドやオプションの形式について説明します。

インストール

Ncloud Storage CLIは、AWS CLIをインストールして使用します。インストールコマンドは次の通りです。

pip3 install awscli

参考

pip3コマンドでは AWS CLI v1がインストールされます。このガイドの例は v1の出力を基準に作成されています。AWS CLI v2のインストール方法は、AWS CLIインストールガイドをご参照ください。

認証

認証情報を設定するコマンドは次の通りです。

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]

参考

access_key_idとsecret_keyを確認する方法については、APIの認証キーをご参照ください。
Ncloud Storageは、現在 KRリージョンのみサポートしています。
対応している出力形式はjson、text、table、yaml、yaml-streamです。

構文

awsの構文は次の通りです。

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

参考

CLIを利用する際は、必ず--endpoint-urlオプションを入力してください。リージョンごとの呼び出しドメインは次の通りです。
- リージョン: 韓国
- リージョン名: kr
- 呼び出しドメイン: https://kr.ncloudstorage.com
提供リージョンは今後も継続的に拡大していく予定です。

s3は Ncloud Storageをファイルシステムのように扱う High-levelコマンドであり、s3apiは Ncloud Storage APIと1:1で対応する API-levelのコマンドです。

ヘルプを確認するコマンドは次の通りです。

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

オプション

awsで共通して使用できるオプションです。

オプション	タイプ	必須の有無	説明
`--endpoint-url`	String	Required	コマンドを呼び出すエンドポイント URL `https://kr.ncloudstorage.com` KRリージョンのみ対応
`--region`	String	Optional	リージョン `kr`
`--profile`	String	Optional	認証情報ファイルおよび設定ファイルで使用するプロファイル名デフォルト: `default` 認証情報以外にも、リージョンや出力形式などプロファイルに保存された設定も併せて適用
`--no-sign-request`	Boolean	Optional	リクエスト署名を無効化認証情報を読み込まず匿名でリクエスト
`--cli-input-json`, `--cli-input-yaml`	String	Optional	JSONまたは　YAML形式でコマンドのパラメータを入力 `file://`接頭辞を使用してローカルファイルパスを指定 JSONと YAMLを同時に指定不可 API-levelのコマンドのみ対応
`--generate-cli-skeleton`	String	Optional	コマンドを実行せずにパラメータテンプレートを作成 `input` (デフォルト) \| `yaml-input` \| `output` API-levelのコマンドのみ対応
`--cli-auto-prompt`	Boolean	Optional	オプション自動プロンプトを有効化コマンドとオプションを会話形式で選択して入力
`--no-cli-auto-prompt`	Boolean	Optional	オプション自動プロンプトを無効化
`--output`	String	Optional	レスポンス結果の形式 `json` (デフォルト) \| `text` \| `table` \| `yaml` \| `yaml-stream`
`--query`	String	Optional	レスポンス結果の絞り込みに使用する JMESPathクエリ
`--color`	String	Optional	出力色を使用するか `on` \| `off` \| `auto` (デフォルト)
`--no-paginate`	Boolean	Optional	自動ページネーションを無効化結果の最初のページのみ照会
`--no-cli-pager`	Boolean	Optional	CLIページャーを無効化ページャーを経由せず標準出力で結果を返す
`--ca-bundle`	String	Optional	SSL証明書を検証する際に使用する CA証明書バンドルのパス
`--no-verify-ssl`	Boolean	Optional	SSL証明書検証を無効化
`--cli-connect-timeout`	Integer	Optional	最大接続時間 (秒) デフォルト: `60` `0`を入力するとタイムアウトなしでグロック状態で動作
`--cli-read-timeout`	Integer	Optional	最大読み取り時間 (秒) デフォルト: `60` `0`を入力するとタイムアウトなしでブロック状態で動作
`--debug`	Boolean	Optional	デバッグロギングを有効化

Ncloud Storageのコマンド

aws配下で使用できるサブコマンドの一覧です。

High-level

High-levelコマンドを使用すると、Ncloud Storageをファイルシステムのようにアクセスしたり管理することができます。関連するコマンドは次の通りです。

コマンド	説明
mb	バケットを作成
ls	バケットとオブジェクトを照会
cp	オブジェクトをコピー
mv	バケットを移動
sync	オブジェクトを同期
presign	オブジェクトの事前署名付き(Pre-signed) URLを作成
rm	オブジェクトを削除
rb	バケットを削除

API-level

API-levelのコマンドは、Ncloud Storage APIと1:1で対応しています。関連するコマンドは次の通りです。

コマンド	説明
create-bucket	Ncloud Storageにオブジェクト保存先のバケットを作成
list-buckets	ユーザーが所有するすべてのバケットリストを照会
head-bucket	Ncloud Storageに作成したバケットの属性を照会
get-bucket-location	Ncloud Storageに作成したバケットのリージョン情報を照会
delete-bucket	Ncloud Storageに作成したバケットを削除
get-bucket-versioning	バケットのバージョン管理設定の有無を照会
put-bucket-versioning	バケットのバージョン管理を設定
get-bucket-encryption	バケットに設定された暗号化方式を照会
put-bucket-encryption	バケットにデフォルトのサーバ側暗号化(SSE)を設定
delete-bucket-encryption	バケットに設定された暗号化設定を削除
get-bucket-cors	バケットに設定された CORSルールを照会
put-bucket-cors	バケットに CORSルールを設定
delete-bucket-cors	バケットに設定された CORSルールを削除
get-bucket-lifecycle-configuration	バケットに登録されたライフサイクルルールを照会
put-bucket-lifecycle-configuration	バケットにライフサイクルルールを登録
delete-bucket-lifecycle	バケットに登録されたライフサイクルルールを削除
get-object-lock-configuration	バケットに設定された Object Lock設定を照会
put-object-lock-configuration	バケットに Object Lock設定を適用
put-object	Ncloud Storageにオブジェクトを保存
get-object	Ncloud Storageに作成したオブジェクトをダウンロード
head-object	Ncloud Storageに保存したオブジェクトのメタデータを照会
copy-object	Ncloud Storageに保存したオブジェクトをコピー
get-object-attributes	Ncloud Storageに保存されたオブジェクトの属性を照会
list-objects	バケットに保存されたオブジェクトリストを照会
list-objects-v2	バケットに保存されたオブジェクトリストを照会
list-object-versions	バージョン管理を使用しているバケットに保存されたオブジェクトのすべてのバージョンのメタデータを照会
delete-object	Ncloud Storageに保存したオブジェクトを削除
delete-objects	Ncloud Storageに保存した複数のオブジェクトを同時に削除
restore-object	Deep Archive Classに保存したオブジェクトを復元
get-object-legal-hold	オブジェクトに設定されたリーガルホールド(Legal Hold)状態を照会
put-object-legal-hold	オブジェクトにリーガルホールド(Legal Hold)を設定
get-object-retention	オブジェクトに設定されたリテンション(Retention)情報を照会
put-object-retention	オブジェクトにリテンション(Retention)を設定
create-multipart-upload	マルチパートアップロードを開始し、アップロード IDを返す
upload-part	マルチパートアップロードのパートをアップロード
upload-part-copy	Ncloud Storageに保存されている大容量オブジェクトをコピー
list-parts	特定のマルチパートアップロードを通じてアップロードされたパートリストを照会
list-multipart-uploads	現在実行中のマルチパートアップロードリストを照会
complete-multipart-upload	アップロードしたパートを組み合わせてオブジェクトを作成し、マルチパートのアップロードを完了
abort-multipart-upload	実行中のマルチパートアップロードを中断

Ncloud Storage関連リソース

Ncloud Storage CLIについてユーザーの理解に役立つよう、さまざまな関連リソースを提供しています。

Ncloud Storage CLIサービスの使用方法
- Ncloud Storageご利用ガイド: NAVERクラウドプラットフォームコンソールで Ncloud Storageを使用する方法
- Ncloud Storage APIガイド: Ncloud Storage APIの呼び出し方法
- Ncloud Storage利用環境ガイド: VPC、Classic環境およびサポートの有無に関するご利用ガイド
- 料金の紹介、特徴、詳細機能: Ncloud Storageの料金体系、特長、詳細機能のサマリー
- サービスの最新情報: Ncloud Storageに関する最新情報
- よくある質問: Ncloud Storageユーザーからよく寄せられる質問とその回答
- サポート: CLIガイドでは解決できない場合のお問い合わせ窓口