ニフクラAPI
ニフクラAPIは、ニフクラの操作(サーバー・ディスク・イメージ・ロードバランサーなど)が可能なAPIです。
- コントロールパネルとは別に、サーバーやディスクの作成・起動・停止やステータス参照などの操作を、外部プログラムから実行するための方法としてAPIを提供しています。
- ニフクラAPIを利用するためには、ニフクラIDの登録と、ニフクラへのお申し込みが必要です。
ニフクラAPI利用にあたっての前提知識
このマニュアルは、以下の知識を持つ方を対象として制作されています。
- XMLに関する知識(「W3 Schools XML Tutorial」参照)
- Webサービスの基本構造に関する知識(「W3 Schools Web Services Tutorial」参照)
- プログラミングに関する知識
- ニフクラでのサーバー構築・運用に関する知識
それぞれの利用方法については以下をご覧ください。
AccessKey/SecretAccessKeyの取得
AccessKeyとSecretAccessKeyを使って認証を行います。
各Keyを取得し、認証文字列を生成し、リクエスト情報にこの認証文字列を付加することで、ニフクラAPIシステムで認証が可能となります。
AccessKeyとSecretAccessKeyの取得の方法については、ヘルプをご確認ください。
エンドポイントについて
ニフクラAPIで利用可能なエンドポイントについては、以下のページをご確認ください。
ゾーンについて
ゾーンについてはそれぞれ以下のページをご覧ください。
ゾーンの仕様など詳しい紹介
クラウド技術仕様/制限値(共通:ニフクラの基本仕様) リージョン/ゾーン
APIを利用したゾーンの確認について
IP許可制限について
IP許可制限をご利用中の場合、許可されていないIPアドレスからリクエストした場合にエラーとなります。
IP許可制限の詳細につきましては、以下のページをご確認ください。
クラウド技術仕様/制限値(アカウントメニュー:IP許可制限)
サーバータイプ名・APIパラメーター対応について
一部のサーバータイプでコントロールパネル上の表記とAPIパラメーター名が同一ではない点にご注意ください。
コントロールパネルのサーバータイプ名とAPIパラメーター対応の詳細につきましては、以下のページをご確認ください。
ニフクラAPI(サーバータイプ名・APIパラメーター対応表)
サンプルスクリプトについて
ニフクラ SDKやツールを使用するためのサンプルスクリプトは以下を参照してください。
nifcloud-sample