Fujitsu Cloud Direct当社が提供するサービスを法人のお客様へ直接販売するサイトです。

FJcloud実践

FJcloud-VのSDK for PythonとCLIをわかりやすく解説

2021年10月12日

この記事は、ニフクラブログで2021-10-12に公開された記事を移転したものです。

こんにちは、ニフクラエンジニアの b:id:nifcloud-developersです。

今回は、2021年9月に ニフクラ SDK for Python と ニフクラ CLI の正式版をリリースしましたので、簡単にご紹介します。

【ニフクラ SDK for Python】
・GitHub: https://github.com/nifcloud/nifcloud-sdk-python
・ドキュメント:https://nifcloud-sdk-python.readthedocs.io
・PyPI:https://pypi.python.org/pypi/nifcloud

【ニフクラ CLI】
・GitHub: https://github.com/nifcloud/nifcloud-cli

・PyPI: https://pypi.org/project/nifcloud-cli

ニフクラ SDK for Python とは

ニフクラ SDK for Python は、Python からニフクラ API を実行するための SDK（Software Development Kit）です。
この SDK は2018年にリリースした「Developer Preview」の正式版になります。
※「Developer Preview」は名前の通り、実験段階の開発者プレビュー版のことを指します。
※「Developer Preview」リリース当時のブログは以下になります。
FJcloud-VのSDK for Python（Developer Preview）をわかりやすく解説
※「Developer Preview」提供中に ニフクラ Kubernetes Service Hatoba 機能は SDK に対応済みです。

Developer Preview からの変更点

Developer Preview からの主な変更点は、下記サービスへの対応です。

・ニフクラ ESS
・ニフクラ DNS

また、登録する環境変数の prefix が AWS_ から以下のように NIFCLOUD_ に変更しています。

$ export NIFCLOUD_ACCESS_KEY_ID=
$ export NIFCLOUD_SECRET_ACCESS_KEY=
$ export NIFCLOUD_DEFAULT_REGION=jp-east-1

加えて、Developer Preview 時に提供していた nifcloud-debugcli ですが、こちらは ニフクラ CLI として、別リポジトリ/別名称で提供するように変更しました。

ニフクラ CLI とは

ニフクラ CLI は、簡易的な CLI （Command Line Interface）であり、コマンドラインから手軽に SDK を利用した API リクエストを実行できます。
nifcloud-debugcli からの変更点として、インストール時の名称や実行するコマンド名などが異なります。

【インストール方法】

$ pip install nifcloud-cli

【使い方】

## クレデンシャル情報とデフォルトのリージョンを設定
$ export NIFCLOUD_ACCESS_KEY_ID=
$ export NIFCLOUD_SECRET_ACCESS_KEY=
$ export NIFCLOUD_DEFAULT_REGION=jp-east-1

## 利用可能なサービスを閲覧
$ nifcloud help

## 指定したサービスで利用可能なアクションを閲覧
$ nifcloud computing help

## 指定したアクションで利用可能なパラメータを閲覧
$ nifcloud computing create-key-pair help

## 実際のコマンド実行
$ nifcloud computing create-key-pair --key-name foobar123 --password foobar123 

コンテナでの使い方

ニフクラ CLI は GitHub でのコンテナレジストリでの提供も行っています。

【使用例】

## コンテナイメージを pull
$ docker pull ghcr.io/nifcloud/nifcloud-cli:latest

## 利用可能なサービスを閲覧
$ docker run --rm ghcr.io/nifcloud/nifcloud-cli:latest help

## 指定したサービスで利用可能なアクションを閲覧
$ docker run --rm ghcr.io/nifcloud/nifcloud-cli:latest computing help

## 指定したアクションで利用可能なパラメータを閲覧
$ docker run --rm ghcr.io/nifcloud/nifcloud-cli:latest computing create-key-pair help

## 実際のコマンド実行
$ docker run --rm ghcr.io/nifcloud/nifcloud-cli:latest computing create-key-pair --key-name foobar123 --password foobar123 

まとめ

今回、正式版がリリースされたニフクラ SDK for Python とニフクラ CLI を簡単にご紹介しました。
今後も SDK 自体の品質を高めつつ、エンハンスも検討しています。

ご興味を持たれた方は、ぜひとも一度 SDK や CLI をお試しください！
そして、GitHub の issue 等でフィードバックをいただけると非常にうれしいです。

関連記事