API
APIは、当サービスのリソース（サーバー・ディスク・イメージ・ロードバランサーなど）を操作する機能です。
- コントロールパネルとは別に、サーバーやディスクの作成・起動・停止やステータス参照などの操作を、外部プログラムから実行する機能として提供しています。
- APIの利用には、ユーザーIDの登録と当サービスへの申し込みを実施してください。
API利用にあたっての前提知識
本マニュアルは、以下の知識を持つ方を対象としています。
- XMLに関する知識。
- W3 Schools XML Tutorialを参照してください。
- Webサービスの基本構造に関する知識。
- W3 Schools XML Web Servicesを参照してください。
- プログラミングに関する知識。
- 当サービスでのサーバー構築・運用に関する知識。
外部プログラムから当サービスのリソースを操作する方法は、以下を確認してください。
- コマンドラインツール
- SDK
- 各サービスのAPI
AccessKey/SecretAccessKeyの取得
APIの認証には、AccessKeyとSecretAccessKeyを使用します。
各Keyを取得し、認証文字列を生成します。APIシステムの認証は、リクエスト情報に生成した認証文字列を付加して実施します。
AccessKeyとSecretAccessKeyの取得の方法は、クラウド操作方法ガイド(アカウントメニュー:アクセスキー)を確認してください。オブジェクトストレージサービスの認証キーの取得、作成方法は、クラウド操作方法ガイド(オブジェクトストレージサービス)を確認してください。
エンドポイント
サービスおよびリージョン毎にエンドポイントが異なります。API（エンドポイント）から確認してください。
ゾーン
ゾーンの仕様、APIを利用したゾーンの指定およびゾーンの確認は、以下を確認してください。
IP許可制限
IP許可制限により、リクエスト送信元のIPアドレスを限定できます。
IP許可制限の詳細は、クラウド技術仕様/制限値（アカウントメニュー:IP許可制限）を確認してください。
サーバータイプ名・APIパラメーター名の対応
一部のサーバータイプでは、コントロールパネル上の表記とAPIパラメーター名が異なります。
コントロールパネルのサーバータイプ名とAPIパラメーター名の対応は、クラウド技術仕様/制限値（API(サーバータイプ名・APIパラメーター対応表)）を確認してください。
サンプルスクリプト
SDKやツールを使用するためのサンプルスクリプトは、nifcloud-sampleを参照してください。
APIの利用履歴
APIの利用履歴はアクティビティログに記録されます。
アクティビティログの操作方法は、クラウド操作方法ガイド(アカウントメニュー:アクティビティログ)を確認してください。
記録されるログの形式は、以下のとおりです。
2017/06/11 16:27:36 BCT***** ***.***.***.*** Computing API（利用状況） DescribeUsage[yearMonth:201704,isCharge:false]REST/2.2 正常
2017/06/11 16:26:10 BCT***** ***.***.***.*** Computing API（ダッシュボード） DescribeResources[]REST/1.20 正常
