$ nifcloud computing describe-instances
GROUPSET testfw
INSTANCESSET 2 x86_64 xxx.xxx.xxx.xxx 2 273 Rocky Linux 8.5 Server01 e-mini i-0k843qvm xxx.xxx.xxx.xxx static 2 static PRIVATE_LAN rockylinux xxx.xxx.xxx.xxx xxx.xxx.xxx.xxx disk default
INSTANCESTATE 16 running
MONITORING disabled
NETWORKINTERFACESET xx:xx:xx:xx:xx:xx net-COMMON_GLOBAL in-use
ASSOCIATION xxx.xxx.xxx.xxx
ATTACHMENT true 0 attached
NETWORKINTERFACESET xx:xx:xx:xx:xx:xx net-xxxxxxxx PLAN1 xxx.xxx.xxx.xxx in-use
ATTACHMENT true 0 attached
PLACEMENT east-14
PRODUCTCODES
STATEREASON
VMTOOLS running 11.2.5目次
はじめに
-
本ドキュメントは、ニフクラAPI活用ガイドとなります。
-
ニフクラAPIの概要
-
API利用のための事前準備
-
コマンドラインツールの利用
-
SDKの利用
-
-
ニフクラサービスの変更は最新のドキュメントを参照してください。
ニフクラAPIの概要
ニフクラ API とは
ニフクラAPIとは、ニフクラの一部機能を、プログラマブルに操作するためのインターフェースとなります。また、SDKやコマンドラインツールを利用することで、直接APIを呼び出さなくても、簡単にこの機能を使うことも可能です。
API を利用してイメージ一覧を表示する例
コントロールパネルでのイメージ一覧表示例
コマンドラインツールを使って表示したサーバー情報取得の例
API 利用のための事前準備
API 利用前の事前情報の取得
-
APIを利用するためには、事前に以下の情報を取得しておく必要があります。
-
認証情報
-
ニフクラAPIでは、認証情報としてアクセスキー、シークレットアクセスキーの2つのキーを利用します。コントロールパネルから、事前にこれらのキーを取得してください。
-
-
エンドポイント
-
どのリージョンのAPIに対してリクエストを送信するか、エンドポイントを使って指定します。WEBサイトで公開されているエンドポイントの中から、目的のリージョンを選択してください。
-
-
プロキシサーバー情報
-
APIにリクエスト送付するクライアント環境について、もし、プロキシサーバー経由でアクセスするネットワーク構成になっている場合、そのプロキシサーバーの情報も取得しておく必要があります。
(プロキシサーバーを経由せず、直接インターネットと通信できる環境であれば、この情報は不要です。)
-
-
それぞれの情報を取得する方法について、次ページ以降で解説します。
認証情報の取得方法
アクセスキーとシークレットアクセスキーは、コントロールパネルから取得します。
プロキシサーバーについて
本例の右図の環境のように、プロキシサーバー経由でインターネットにアクセスしている場合は、
-
④プロキシサーバー名(もしくはIPアドレス)
-
⑤ポート番号
等の情報が必要になります。
このようにインターネットへ接続する際の条件については、利用者環境のネットワーク担当者に事前確認をしてください。
API 利用のための注意事項
-
APIバージョンの更新について
ニフクラでは、定期的に新しいバージョンのAPIをリリースしています。同時に、旧バージョンのAPIを順次終了します。留意してください。 -
サーバータイプ名について
コントロールパネル上の表記とAPIパラメーター名は必ずしも一致しません。 詳細はサーバータイプ名・APIパラメーター対応表を参照してください。 -
v4パラメーター計算時に利用する、各種文字列、ヘッダは、 サービスごとに指定できるパラメーター名が異なります。
以下を参考にしてください。
コマンドラインツールの利用
コマンドラインツールの利用に際して
-
コマンドラインツールを利用する場合は、以下のページを参照してください。
ニフクラ SDKの利用
ニフクラ SDKの利用に際して
-
ニフクラ SDKを利用する場合は、以下のページを参照してください。
