本文へジャンプします。

ニフクラ APIリファレンス

コマンドラインツールの認証方式と環境変数

コマンドラインツールの認証方式

AccessKeyIDとSecretAccessKeyを使って認証文字列を自動生成し認証を行います。

AccessKeyIDとSecretAccessKeyの取得の方法
ニフクラ コントロールパネルへログインします。
アカウントメニューへ遷移します。
認証キーの取得を行います。
画面に表示されたアクセスキーとシークレットアクセスキーの文字列をコピーします。
  • ※1度作成したAccessKeyIDとSecretAccessKeyは、上記2.にて取得できます。再作成する場合は、上記手順を再度行ってください。
認証文字列の生成と付加の方法

環境変数にAccessKeyIDとSecretAccessKeyを設定します。

環境変数と設定方法

コマンドラインツールの動作には、以下の環境変数を設定する必要があります。

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のニフクラ エンドポイントへリクエストします。
設定方法のサンプル(Windows)
$ set NIFTY_CLOUD_HOME=C:\nifty-cloud\NIFCLOUD_api-tools_8.0.0
$ set PATH=%PATH%;%NIFTY_CLOUD_HOME%\bin
$ set JAVA_HOME=C:\Java\jre1.8.0_191
$ set NIFTY_ACCESS_KEY_ID=QWERTYUIOPASDFGHJKL
$ set NIFTY_SECRET_KEY=zXCVB12NMlko345ErseNrgs3l
設定方法のサンプル(Linux)
$ export NIFTY_CLOUD_HOME=/home/nifty/nifty-cloud/NIFCLOUD_api-tools_8.0.0
$ export PATH=$PATH:$NIFTY_CLOUD_HOME/bin
$ export JAVA_HOME=/usr/local/java
$ export NIFTY_ACCESS_KEY_ID=QWERTYUIOPASDFGHJKL
$ export NIFTY_SECRET_KEY=zXCVB12NMlko345ErseNrgs3l

エンドポイントの切り替え方法

環境変数で切り替える
環境変数「NIFTY_CLOUD_URL」でリクエスト先を切り替えることが可能です。
例:
$ set NIFTY_CLOUD_URL=https://jp-west-1.computing.api.nifcloud.com/api/
コマンドラインツールの共通オプションで切り替える
共通オプション「--url」でリクエスト先を切り替えることが可能です。
例:
$ nifty-describe-instances --url https://jp-west-1.computing.api.nifcloud.com/api/
プロパティファイルで切り替える
ニフクラ SDKのプロパティファイルを書き換えてリクエスト先を指定することが可能です。

以下のページより、最新の「ニフクラ SDK for Java 8.0.0」をダウンロードします。

nifty_cloud-sdk.properties を編集します。

nifty_cloud.sdk.url=https://jp-west-1.computing.api.nifcloud.com/api/

antコマンドでニフクラ SDKをコンパイルし、jarファイルを生成します。

$ ant

コマンドラインツールのライブラリフォルダ(lib)へ、生成したjarファイルを配置します。

リクエストメソッド(GET/POST)の切り替え方法

コマンドラインツールの共通オプションで切り替える
共通オプション「--request-method」でGET/POSTを切り替えることが可能です。
例:
$ nifty-describe-instances --request-method POST
プロパティファイルで切り替える
ニフクラ SDKのプロパティファイルを書き換えてGET/POSTを指定することが可能です。

上記「エンドポイントの切り替え方法」の「プロパティファイルで切り替える」を参考に、ニフクラSDKをダウンロード・コンパイルします。

●リクエストメソッドをGETにする場合

nifty_cloud.sdk.request_method=GET;

●リクエストメソッドをPOSTにする場合

nifty_cloud.sdk.request_method=POST;

ニフティクラウド サイト内検索

APIメニュー

  • ツイッターでフォローしてください
  • ニフクラ公式フェイスブックページ

推奨画面サイズ 1024×768 以上