本文へジャンプします。

TOP

ニフクラSEハンドブック

クラウド トップ>SEハンドブック>API操作環境について

API操作環境について

ドキュメント情報

区分

Tips

リリース日

2022年7月1日

留意事項

2022 年 3 月時点の機能をもとに作成しております。
機能は順次エンハンスされますので、検討時にはニフクラホームページにて最新情報を確認ください。

■ニフクラホームページ

https://pfs.nifcloud.com/

はじめに

  • 本ドキュメントでは、ニフクラに対するAPI操作方法の例を記します。

    • ニフクラAPIの概要

    • API利用のための事前準備

    • コマンドラインツールの利用

    • SDKの利用

  • 本ドキュメントの注意事項

    • 本ドキュメントは、2022年3月時点の機能をもとに作成しています。ニフクラは継続的にエンハンスが行われるクラウドサービスです。

  • ニフクラサービスの変更は最新のドキュメントを参照してください。

ニフクラAPIの概要

ニフクラ API とは

ニフクラAPIとは、ニフクラの一部機能を、プログラマブルに操作するためのインターフェースとなります。また、SDKやコマンドラインツールを利用することで、直接APIを呼び出さなくても、簡単にこの機能を使うことも可能です。

image

API を利用してイメージ一覧を表示する例

コントロールパネルでのイメージ一覧表示例

image

コマンドラインツールを使って表示したサーバー情報取得の例

$ nifty-describe-instances
GROUP  fwgroup01
INSTANCE server01 i-0000usn7 68 stopped sshkey01 mini 2019-01-01T09:00:00+09:00 east-11 disabled disk 1 1 static static memo x86_64 centos STANDARD default 2
NETWORK_INTERFACE  net-COMMON_GLOBAL    in-use
NETWORK_INTERFACE_ATTACHMENT  0  attached  true
NETWORK_INTERFACE_ASSOCIATION
NETWORK_INTERFACE  net-COMMON_PRIVATE    in-use
NETWORK_INTERFACE_ATTACHMENT  0  attached  true

API 利用のための事前準備

API 利用前の事前情報の取得
  • APIを利用するためには、事前に以下の情報を取得しておく必要があります。

    • 認証情報

      • ニフクラAPIでは、認証情報としてアクセスキー、シークレットアクセスキーの二つのキーを利用します。コントロールパネルから、事前にこれらのキーを取得してください。

    • エンドポイント

      • どのリージョンのAPIに対してリクエストを送信するか、エンドポイントを使って指定します。WEBサイトで公開されているエンドポイントの中から、目的のリージョンを選択してください。

    • プロキシサーバー情報

      • APIにリクエスト送付するクライアント環境について、もし、プロキシサーバー経由でアクセスするネットワーク構成になっている場合、そのプロキシサーバーの情報も取得しておく必要があります。
        (プロキシサーバーを経由せず、直接インターネットと通信できる環境であれば、この情報は不要です。)

それぞれの情報を取得する方法について、次ページ以降で解説します。

認証情報の取得方法

アクセスキーとシークレットアクセスキーは、コントロールパネルから取得します。

image

エンドポイントの取得方法

エンドポイントは下記URLに公開されています。
https://pfs.nifcloud.com/api/endpoint.htm

image

例えば、east-2リージョンに対してAPI操作を行う場合、
https://jp-east-2.computing.api.nifcloud.com/api/ というエンドポイントを利用します。

プロキシサーバーについて

image

本例の右図の環境のように、プロキシサーバー経由でインターネットにアクセスしている場合は、

  • ④プロキシサーバー名(もしくはIPアドレス)

  • ⑤ポート番号

等の情報が必要になります。このようにインターネットに接続する際の条件については、利用者環境のネットワーク担当者に事前に確認しておいてください。

API 利用のための注意事項

APIバージョンの更新について

ニフクラでは、定期的に新しいバージョンのAPIをリリースしています。同時に、旧バージョンのAPIを順次終了します。留意してください。

コマンドラインツールの利用

コマンドラインツールのダウンロード(Windows)

下記URLより「ニフクラ CLI 8.0.2」をダウンロードしてください。
https://pfs.nifcloud.com/api/cli/

image

ダウンロードしたファイル「NIFCLOUD_api-tools_8.0.2.zip」を解凍すると、以下のように展開されます。

image

コマンドラインツールのダウンロード(Linux)

Linux環境の場合は、以下のようにファイルを取得・解凍後に、実行権限を付与してください。

wget https://pfs.nifcloud.com/api/sdk/java8/NIFCLOUD_api-tools_8.0.2.zip
unzip ./NIFCLOUD_api-tools_8.0.2.zip
chmod +x ./NIFCLOUD_api-tools_8.0.2/bin/*
JREのダウンロードとインストール
環境変数の設定(Windows)
  • コマンドラインツールの動作には、以下の環境変数を設定する必要があります。

No

環境変数

設定する値

1

NIFTY_CLOUD_HOME

コマンドラインツールを展開したパス

2

NIFTY_CLOUD_URL

ニフクラAPIのサーバーのURL ※省略可

3

NIFTY_ACCESS_KEY_ID

AccessKeyIDの文字列

4

NIFTY_SECRET_KEY

SecretAccessKeyの文字列

5

JAVA_HOME

Javaをインストールしたディレクトリのパス

6

JAVA_OPTS

Javaの実行オプション (プロキシ設定)  ※省略可

※NIFTY_CLOUD_URLを省略した場合、jp-east-1のニフクラエンドポイントへリクエストします。

以下のように環境変数を設定します。

SET JAVA_HOME=C:\Program Files\Java\jre-x.x.x ←JREをインストールしたパスを指定します
SET NIFTY_CLOUD_HOME=C:\NIFCLOUD_api-tools_8.0.2
SET PATH=%PATH%;%NIFTY_CLOUD_HOME%\bin
SET NIFTY_ACCESS_KEY_ID=①アクセスキー
SET NIFTY_SECRET_KEY=②シークレットアクセスキー
SET NIFTY_CLOUD_URL=③エンドポイント

また、プロキシサーバーを利用する環境では、以下の環境変数も設定します。

SET JAVA_OPTS=-Dhttp.proxyHost= ④プロキシサーバー名 -Dhttp.proxyPort=⑤ポート番号
環境変数の設定(Linux)
  • コマンドラインツールの動作には、以下の環境変数を設定する必要があります。

No

環境変数

設定する値

1

NIFTY_CLOUD_HOME

コマンドラインツールを展開したパス

2

NIFTY_CLOUD_URL

ニフクラAPIのサーバーのURL ※省略可

3

NIFTY_ACCESS_KEY_ID

AccessKeyIDの文字列

4

NIFTY_SECRET_KEY

SecretAccessKeyの文字列

5

JAVA_HOME

Javaをインストールしたディレクトリのパス

6

JAVA_OPTS

Javaの実行オプション (プロキシ設定)  ※省略可

※NIFTY_CLOUD_URLを省略した場合、jp-east-1のニフクラエンドポイントへリクエストします。

以下のように環境変数を設定します。

export JAVA_HOME=/usr/java/jre-x.x.x ←JREをインストールしたパスを指定します
export NIFTY_CLOUD_HOME=/home/nifty/nifty-cloud/NIFCLOUD_api-tools_8.0.2
export PATH=$PATH:$NIFTY_CLOUD_HOME/bin
export NIFTY_ACCESS_KEY_ID=①アクセスキー
export NIFTY_SECRET_KEY=②シークレットアクセスキー
export NIFTY_CLOUD_URL=③エンドポイント

また、プロキシサーバーを利用する環境では、以下の環境変数も設定します。

export JAVA_OPTS=-Dhttp.proxyHost= ④プロキシサーバー名 -Dhttp.proxyPort=⑤ポート番号
コマンドラインツールの実行

登録されているイメージ一覧を取得する「nifty-describe-images」を実行してみます。

(Windows環境での例)

C :\> nifty-describe-images

(Linux環境での例)

$ nifty-describe-images

以下の例のように、イメージ一覧の取得結果が得られます。

IMAGE 89 Ubuntu Server 16.04 LTS niftycloud FUJITSU CLOUD TECHNOLOGIES LIMITED available public x86_64 machine ubuntu disk true
IMAGE 157 Windows Server 2016 Std niftycloud FUJITSU CLOUD TECHNOLOGIES LIMITED available public x86_64 machine windows disk true
IMAGE 158 Windows Server 2016 Std + SQL Server 2016 Std niftycloud FUJITSU CLOUD TECHNOLOGIES LIMITED available public x86_64 machine windows disk true
IMAGE 166 Windows Server 2016 Std + RDS niftycloud FUJITSU CLOUD TECHNOLOGIES LIMITED available public x86_64 machine windows disk true
IMAGE 167 Windows Server 2016 Std + RDS + Office 2016 Std niftycloud FUJITSU CLOUD TECHNOLOGIES LIMITED available public x86_64 machine windows disk true
IMAGE 168 Ubuntu Server 18.04 LTS niftycloud FUJITSU CLOUD TECHNOLOGIES LIMITED available public x86_64 machine ubuntu disk true
SDKの利用
「ニフクラ SDK for Java」のダウンロード

下記URLより、「ニフクラ SDK for Java 8.0.2」をダウンロードしてください。
https://pfs.nifcloud.com/api/sdk/

image

ダウンロードしたファイル「NIFCLOUD_SDK_for_Java_8.0.2.zip」を解凍すると、以下のように展開されます。

image

Eclipse のダウンロードとインストール
  • SDKを利用するプログラムの開発環境として、ここではEclipseを利用します。

  • 外部サイトの下記URLよりEclipseをダウンロードし、SDK利用環境にインストールしてください。
    http://mergedoc.osdn.jp/

  • (このドキュメントでは、「Eclipse 4.7 OXYGEN1a」Java/FullEditionのWindows版をダウンロードして利用しています。)

Eclipse のプロジェクトの作成

Eclipseを起動後、[ファイル]-[新規]-[Javaプロジェクト]により、新規プロジェクトを作成します。

image

「nifty-cloud-api-lib.jar」を組み込み

以下の手順①~⑤に従いプロジェクトへ「nifty-cloud-api-lib.jar」を組み込みます。(該当のjarファイルは、zipファイル解凍先のdist\lib\の下にあります。)

image

image

「third-party」のjarの組み込み

以下の手順①~⑤に従いプロジェクトへ「third-party」を組み込みます。 (該当のフォルダは、zipファイル解凍先の直下にあります。)

image

image

「DescribeImageSample.java」の組み込み

以下の手順①~⑤に従いプロジェクトへ「DescribeImageSample.java」を組み込みます。 (該当のソースファイルは、zipファイル解凍先のsrc\com\nifty\cloud\sdk\sample\の下にあります。)

image

image

アクセスキーとシークレットアクセスキーの書き込み

表示したサンプルソース内にアクセスキーとシークレットアクセスキーを書き込みます。

image

サンプルソースの編集(エンドポイント)

表示したサンプルソースにエンドポイントを書き込みます。

image

サンプルソースの編集(インターネット接続条件)

表示したサンプルソースに (必要に応じて) インターネット接続条件を書き込みます。

image

Javaアプリケーションの実行

[実行]-[実行構成]から、Javaアプリケーションを構成・実行します。

image

実行結果例

実行結果の例として、以下のように出力されます。

image

導入のご相談はお電話でも受け付けております。

0120-22-1200

0120-22-1200

受付時間:9:00~17:45(土日祝・当社指定の休業日を除く)
※携帯電話・PHSからもご利用可能