クラウド CLI（コマンドラインツールについて）

ニフクラ コマンドラインツール

ニフクラでのリソースの作成・起動・停止やステータス参照などの操作を可能にするコマンドラインツールです。
スクリプトを作成して操作の自動化を容易に実現できます。

ニフクラ データ駆動 コマンドラインツール

ニフクラ データ駆動 コマンドラインツールはニフクラの複数サービスに対応しているコマンドラインツールです。
現在対応しているサービスは以下となります。

• Computing
• RDB
• NAS
• DNS
• ESS
• オブジェクトストレージサービス
• サービスアクティビティ

ニフクラ CLI

ニフクラ CLI（GitHub） ニフクラ CLI（PyPI） ニフクラ CLI（Read the Docs）

エンドポイントについて

ニフクラの各サービスで利用可能なリージョン/エンドポイントについては、以下のページをご確認ください。

ニフクラAPI（エンドポイント）

インストール (Linux)

以下のコマンドを実行してインストールを実施します。

$ pip install nifcloud-cli

下記のコマンドを実行し、バージョン情報が出力されれば、正常にインストールされています。

$ nifcloud --version

インストール (Windows)

最新のWindows用MSIインストーラをダウンロードして実行します。

ニフクラ CLI 最新リリース (GitHub)

下記のコマンドをコマンドプロンプトから実行し、バージョン情報が出力されれば、正常にインストールされています。

C:\> nifcloud --version

認証情報等の設定

環境変数、もしくは nifcloud configure コマンドから設定できます。
頻繁にCLIを利用する場合など、設定を永続化したい場合は nifcloud configure コマンドをご利用ください。

環境変数の場合

• Linuxの場合

$ export NIFCLOUD_ACCESS_KEY_ID=<Your NIFCLOUD Access Key ID>
$ export NIFCLOUD_SECRET_ACCESS_KEY=<Your NIFCLOUD Secret Access Key>
$ export NIFCLOUD_DEFAULT_REGION=jp-east-1

• Windowsの場合

C:\> set NIFCLOUD_ACCESS_KEY_ID=<Your NIFCLOUD Access Key ID>
C:\> set NIFCLOUD_SECRET_ACCESS_KEY=<Your NIFCLOUD Secret Access Key>
C:\> set NIFCLOUD_DEFAULT_REGION=jp-east-1

nifcloud configure コマンドの場合

$ nifcloud configure
NIFCLOUD Access Key ID [None]:
NIFCLOUD Secret Access Key [None]:
Default region name [None]:
Default output format [None]:

なお、ここで入力した内容は下記のディレクトリ配下に保存されます。

• Linux: $HOME/.nifcloud
• Windows: %UserProfile%\.nifcloud

実行

サーバー情報取得のコマンドを実行して動作を確認します。

$ nifcloud computing describe-instances

コマンドの使い方は、ヘルプオプションでも確認できます。

$ nifcloud computing describe-instances help

CLIの利用履歴

ニフクラCLIの利用履歴もアクティビティログに記録されます。
アクティビティログの操作方法はクラウド操作方法ガイド(アカウントメニュー:アクティビティログ)を確認してください。

記録されるログは以下の形式となります。

2025/2/21 13:58:36 BCT***** ***.***.***.*** コンピューティング API（利用状況） DescribeUsage[yearMonth:202502,isCharge:false] 正常
2025/2/21 13:58:31 BCT***** ***.***.***.*** コンピューティング API（ダッシュボード） DescribeResources[] 正常