ニフクラユーザーガイド（API活用ガイド）

【重要なお知らせ】サービス統合に基づくサービス名称の読み替えのお願い（2024年4月1日）

2024年4月1日をもって、「ニフクラ」は、「FJcloud-V」に統合し、名称を変更しました。
当サイトのアドレス（ドメイン名）に含まれる「nifcloud.com」は現時点では変更はございませんが、
各ページに記載の「ニフクラ」「NIFCLOUD」「nifcloud」は、「FJcloud-V」に読み替えていただきますようお願いいたします。

ニフクラユーザーガイド

クラウドトップ>ユーザーガイド>API活用ガイド

はじめに
ニフクラAPIの概要
- ニフクラ API とは
- API を利用してイメージ一覧を表示する例
API 利用のための事前準備
コマンドラインツールの利用
- コマンドラインツールの利用に際して
ニフクラ SDKの利用
- ニフクラ SDKの利用に際して

はじめに

本ドキュメントは、ニフクラAPIの活用ガイドです。
- ニフクラAPIの操作方法、注意事項などを解説しています。
ニフクラサービスの変更は最新のドキュメントを参照してください。

ニフクラAPIの概要

ニフクラ API とは

ニフクラAPIとは、ニフクラの一部機能をプログラマブルに操作するためのインターフェースです。
より簡単に利用するため、SDKやコマンドラインツールも提供しています。

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

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

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

$ 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を利用するには、事前に以下情報を取得してください。

情報	説明
認証情報	ニフクラAPIでは、認証情報としてアクセスキー、シークレットアクセスキーの2つのキーを利用します。コントロールパネルから、事前にこれらのキーを取得してください。
エンドポイント	どのリージョンのAPIに対してリクエストを送信するか、エンドポイントを使って指定します。WEBサイトで公開されているエンドポイントの中から、目的のリージョンを選択してください。
プロキシサーバー情報	APIにリクエスト送付するクライアント環境が、プロキシサーバー経由でアクセスするネットワーク構成の場合、プロキシサーバーの情報も取得してください。直接インターネットと通信できる環境の場合、この情報は不要です。

情報

説明

認証情報