Object Storageの概要

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

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

Object Storageの共通設定

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

インストール

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

pip install awscli==1.15.85

参考

awscli 1.16.x以降のバージョンでは一部機能がサポートされないため、1.15.x系のご利用を推奨します。
awscli 1.15.85バージョンは Python 3.8以前のバージョンで動作します。
関連資料については、次をご参照ください。
- ドキュメント: awscli 1.15.85
- git: aws-cli 1.15.85

認証

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

aws configure

コマンドを実行すると、次の項目を順に入力します。

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]

参考

access_key_idとsecret_keyはNcloudAPIを参照して作成した API認証キーを使用します。
Roleを付与されたサーバは、別途認証設定を行うことなく Object Storageコマンドを使用できます。この場合、Metadata APIの認証キー照会 APIを使用するためタイムアウトが発生する可能性があり、次のコマンドでタイムアウトを延長できます。
```
export AWS_METADATA_SERVICE_TIMEOUT=10
```

構文

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

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

s3はファイル単位の操作に最適化された high-levelコマンドで、s3apiは Object Storage APIと1:1で対応する API-levelコマンドです。

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

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

オプション

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

オプション	タイプ	必須の有無	説明
`--endpoint-url`	String	Required	コマンドを呼び出すエンドポイント URL リージョンごとの呼び出しドメインはObject Storage APIガイドを参照
`--region`	String	Optional	リージョン韓国リージョンのみ対応
`--profile`	String	Optional	認証情報ファイルおよび設定ファイルで使用するプロファイル名デフォルト: `default` 認証情報以外にも、リージョンや出力形式などプロファイルに保存された設定も併せて適用
`--no-sign-request`	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	自動ページネーションを無効化結果の最初のページのみ照会
`--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	デバッグロギングを有効化

Object Storageのコマンド

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

High-level

ファイル単位の操作に使用するs3関連コマンドは次の通りです。

コマンド	説明
mb	バケットを作成
ls	バケット、フォルダ、オブジェクトリストを照会
cp	オブジェクトのアップロード、ダウンロードおよびコピー
sync	ディレクトリとバケット間の同期
rm	オブジェクトを削除
rb	バケットを削除

API-level

Object Storage APIと1:1で対応するs3api関連コマンドは次の通りです。

コマンド	説明
create-bucket	バケットを作成
list-buckets	バケットリストを照会
delete-bucket	バケットを削除
get-bucket-cors	バケット CORSルールを照会
put-bucket-cors	バケット CORSルールを設定
put-object	オブジェクトをアップロード
get-object	オブジェクトをダウンロード
list-objects	オブジェクトリストを照会
put-object-acl	オブジェクトアクセス制御リストを設定
delete-object	オブジェクトを削除
create-multipart-upload	マルチパートアップロードを開始
upload-part	マルチパートアップロードのパートをアップロード
complete-multipart-upload	マルチパートアップロード完了
list-multipart-uploads	進行中のマルチパートアップロードリストを照会
abort-multipart-upload	マルチパートアップロードを停止

Object Storage関連リソース

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

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