Classic/VPC環境で利用できます。
Archive Storageは大量データを低コストで長期間保管できる NAVERクラウドプラットフォームのサービスです。Archive Storageでは、コンテナ(バケット)およびオブジェクト管理機能に関する CLIを、OpenStack Swift CLIと互換性のあるswiftコマンドとして提供しています。
Archive Storageの共通設定
Archive Storage CLIを使用するためのインストールおよび認証方法、共通して使用されるコマンドとオプション形式について説明します。
インストール
Archive Storage CLIは、OpenStack Swiftクライアントをインストールして使用します。Pythonのバージョンに応じて、次のコマンドでインストールしてください。
Python 3.9以前のインストールコマンドは次の通りです。
pip install python-keystoneclient==3.17.0
pip install python-swiftclient==3.6.0
Python 3.10以降のインストールコマンドは次の通りです。
pip install python-keystoneclient==5.1.0
pip install python-swiftclient==4.3.0
OpenStack Swift CLIの詳細は、OpenStack Swift CLIドキュメントをご参照ください。
認証
Archive Storageは、認証情報を使ってトークンを発行し、サービスを利用します。認証コマンドは次の通りです。
swift --os-auth-url https://kr.archive.ncloudstorage.com:5000/v3 --auth-version 3 \
--os-username {access_key_id} --os-password {secret_key} \
--os-user-domain-id {domain_id} --os-project-id {project_id} \
auth
access_key_idとsecret_keyを確認する方法については、APIの認証キーをご参照ください。project_idとdomain_idは、NAVERクラウドプラットフォームコンソールで Archive Storageサービスをお申し込みの後、Container Managementメニューの [API利用情報を確認] ボタンをクリックしてご確認ください。
認証が成功すると、ストレージ URLと認証トークンが返されます。
export OS_STORAGE_URL=https://kr.archive.ncloudstorage.com/v1/AUTH_{project_id}
export OS_AUTH_TOKEN={token}
返されたexportコマンドを実行し、OS_STORAGE_URLとOS_AUTH_TOKENを環境変数として宣言すると、再認証せずにサービスをリクエストできます。
export OS_STORAGE_URL=https://kr.archive.ncloudstorage.com/v1/AUTH_{project_id}
export OS_AUTH_TOKEN={token}
swift list
環境変数として宣言せずに、--os-storage-urlや--os-auth-tokenオプションに値を直接入力することもできます。
swift --os-storage-url https://kr.archive.ncloudstorage.com/v1/AUTH_{project_id} \
--os-auth-token {token} \
list
サービス認証 URLやトークン値を環境変数として保存せずに、認証コマンドを使用して認証情報をリクエストするたびに認証情報を併せて入力する方式は、その都度認証を行うことになるため、推奨しません。
構文
swiftの構文は次の通りです。
swift <subcommand> [options]
オプション
swiftで共通して使用できるオプションです。
| オプション | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
--os-storage-url |
String | Conditional | サービス URL
|
--os-auth-token |
String | Conditional | 発行された認証トークン
|
--os-auth-url |
String | Conditional | 認証 URL
|
--auth-version |
String | Conditional | 認証 APIバージョン
|
--os-username |
String | Conditional | API認証キーの Access Key ID
|
--os-password |
String | Conditional | API認証キーの Secret Key
|
--os-user-domain-id |
String | Conditional | ユーザーが所属するドメイン ID
|
--os-project-id |
String | Conditional | ユーザーが所属するプロジェクト ID
|
Archive Storageコマンド
swift配下で使用できるサブコマンドの一覧です。
| コマンド | 説明 |
|---|---|
| auth | 認証環境変数を出力 |
| post | コンテナ(バケット)の作成およびメタデータの変更 |
| upload | ファイルまたはディレクトリのアップロード |
| list | コンテナ(バケット)リストまたはオブジェクトリストを照会 |
| stat | アカウント、コンテナ(バケット)、オブジェクト情報を照会 |
| download | オブジェクトをダウンロード |
| copy | オブジェクトをコピー |
| tempurl | オブジェクトアクセス用一時 URLを作成 |
| delete | コンテナ(バケット)またはオブジェクトを削除 |
| capabilities | クラスタサポート機能および制限値の照会 |
Archive Storage関連リソース
Archive Storage CLIについてユーザーの理解に役立つよう、さまざまな関連リソースを提供しています。
- Archive Storage CLIサービスの使用方法
- Archive Storageご利用ガイド: NAVERクラウドプラットフォームコンソールで Archive Storageを使用する方法
- Archive Storage APIガイド: Archive Storage APIを呼び出す方法
- Archive Storage利用環境ガイド: VPC、Classic環境およびサポートに関する利用ガイド
- 料金の紹介、特徴、詳細機能: Archive Storageの料金体系、特徴、詳細機能のサマリー
- サービスの最新情報: Archive Storageに関する最新情報
- よくある質問: Archive Storageユーザーからよく寄せられる質問とその回答
- サポート: CLIガイドでは解決できない場合のお問い合わせ窓口