API実行#

機能概要#

本機能は、「APIリファレンス」を参考に、IaaSポータル上からAPIを実行し、その応答結果をポータル上に表示する機能です。IaaSポータルが提供していない機能を実行したい場合や、コマンドラインによるAPI実行環境がない場合にご利用いただけます。また、実行したAPIは履歴機能により最大10件まで保存されます。履歴はプロジェクトおよびリージョンの変更操作により削除されます。
なお、本機能は、全てのAPIにおいて動作保証をしている訳ではありません。正常に動作しない場合は、APIをご利用ください（詳細は「IaaS API リファレンス」参照）。

利用例#

本章では、APIで実行できるメソッドのうち、以下の二つの実行例を説明いたします。その他の利用方法については、APIリファレンスを参考にご利用ください。

GETメソッド ：仮想サーバの一覧取得例を説明します。
POSTメソッド ：仮想サーバの作成例を説明します。 　

API実行に必要な情報#

API実行画面では以下の情報を必要とします。以降の取得例ではこれらの情報の確認方法と設定方法について例をあげて説明します。

表: API実行に必要な情報

項目 説明 必須・任意
リージョン API実行先を選択する。リージョンまたはグローバルを選択可能。 必須
HTTPメソッド APIを実行する際のHTTPメソッドを選択する。 必須
エンドポイント API実行先のコンポーネントを選択する。
「エンドポイント一覧 」を参照ください。		 必須
URI エンドポイントに続くURIを入力する。
APIリファレンスを参照し、入力してください。		 必須
クエリパラメータ クエリのキーと値を入力する。
APIリファレンスを参照し、入力してください。
※キーに同じ文字列を複数指定することはできません。同じ文字列を複数指定する場合は、URI欄に直接記載してください。		 任意
HTTPヘッダ HTTPヘッダのキーと値を入力する。
※キーの追加・削除が可能です。ただし「X-Auth-Token」の指定は必須となります。		 必須
リクエストボディ HTTPリクエストボディを入力する。 任意

　

エンドポイント一覧#

選択可能なエンドポイントは、リージョン選択時、またはグローバル選択時によって異なります。各エンドポイントについては、以下の表を参考に指定してください。

表: エンドポイント一覧(リージョナルサービス)

エンドポイントサービス名対象リージョン
東日本第1/第2
西日本第1/第2		対象リージョン
東日本第3
西日本第3
autoscaleオートスケール○○
baremetalベアメタル-○
※ベアメタル契約者のみ
blockstorage (v2)ブロックストレージ○-
blockstorage (v3)ブロックストレージ-○
computeコンピュート(スタンダードサービス)○○
compute (v2)コンピュート-○
compute (v2.1)コンピュート-○
compute-bコンピュート○○
compute-wコンピュート(SAP向けサービス)○○
databaseデータベース○○
database-exデータベース○-
dnsDNSサービス東日本第1のみ-
filestorageファイルストレージ-東日本第3のみ
identity (v3)利用者管理(リージョナル)○○
imageイメージ管理○○
import-export仮想サーバインポート・エクスポート○○
keymanagement鍵管理○○
loadbalancerロードバランサー-○
loadbalancingロードバランサー○-
logserviceログ提供サービス-○
octaviaロードバランサー-○
mailメール配信○○
networking仮想ネットワーク○○
networking-ex仮想ネットワーク拡張○-
nfvNFVサービス-○
objectstorageオブジェクトストレージ○○
objectstorage-sオブジェクトストレージ[S3互換]-○
orchestrationテンプレート管理(オーケストレーション)○○
softwareソフトウェア管理○○
telemetry監視○○
applicationmanagementアプリケーション管理--
billing課金管理--
blockstorage (v1)ブロックストレージ--
catalog商品管理--
certificate証明書管理--
contractリージョナル契約管理--
identityリージョナル利用者管理--
identity (v2.0)リージョナル利用者管理--
queueキュー管理--
rolemanagementリージョナルロール管理--
vmimport仮想サーバインポート--
identity.gls ※グローバル利用者管理--

※利用する場合は、グローバルサービスのエンドポイントをご利用ください。

(注) リージョン毎に提供されるエンドポイントが異なります。

表: エンドポイント一覧(グローバルサービス)

エンドポイント サービス名 備考
global-billing 課金管理
global-catalog 商品管理
global-cdn コンテンツ配信サービス
global-contract 契約管理
global-identity グローバル利用者管理
global-rolemanagement グローバルロール管理 ご利用いただけません

仮想サーバ一覧取得例#

プロジェクト内の仮想サーバの一覧を取得方法について説明します。

image367
図: API実行画面入力例

  1. リージョンの選択
    APIの実行先を選択します。現在選択中のリージョンまたはグローバルが選択できます。仮想サーバ一覧を取得する場合は「現在選択中のリージョン」を選択します。
    リージョンとグローバルの関係については、「IaaS 機能説明書」の「ロケーションサービス」を参照してください。

  2. HTTPメソッド、URI、クエリパラメータ、HTTPヘッダ、リクエストボディの指定 「APIリファレンス（Foundation Service編）」より目的のAPIのリファレンスを検索します。
    image368
    図: APIリファレンス（Foundation Service編）の参照例
    該当箇所を参考にパラメータを設定します。

    • HTTPメソッド： “GET”
      クエリパラメータには、changessince、image、flavor、name、status、hostを指定することができます。ここでは、仮想サーバのステータスがACTIVEなものでフィルタリングします。
    • クエリパラメータ
      • キー ：“status”
      • 値 ：“ACTIVE”
    • HTTPヘッダ ： 設定不要
    • リクエストボディ ： 設定不要

  3. エンドポイントの選択
    「エンドポイント一覧 」を参照し、該当するエンドポイントを選択します。
    ここでは、仮想サーバ一覧情報を取得するために、「compute」を選択します。

  4. API実行
    必要な情報が全て入力完了したら、「API実行」ボタンを押下します。

  5. 実行結果
    APIの実行結果がレスポンス欄に表示されます。
    image369
    図: APIレスポンス

仮想サーバ作成例#

プロジェクト内に仮想サーバを作成する方法について説明します。

image370
図: 入力例

image371
図: 応答例

  1. リージョンの選択
    仮想サーバを作成する場合は「現在選択中のリージョン」を選択します。
  2. エンドポイントの選択
    前節の仮想サーバ一覧取得例と同様に、「compute」を選択します。
  3. HTTPメソッド、URI、クエリパラメータ、HTTPヘッダ、リクエストボディの指定
    「APIリファレンス（Foundation Service編）」より目的のAPIのリファレンスを検索します。
    image372
    図: APIリファレンス（Foundation Service編）の参照例
    APIリファレンスを参考にパラメータを設定します。
    • HTTPメソッド： "POST"
    • URI： "/v2/{tenant_id}/servers"
    • クエリパラメータ ：設定不要
    • HTTPヘッダ ：設定不要
      リクエストボディ： APIリファレンスの下記を参考に作成します。
      image374
      図: APIリファレンス（Foundation Service編）の参照例
      image375
      図: リクエストボディ作成例
  4. API実行
    必要な情報が全て入力完了したら、「API実行」ボタンを押下します。
  5. 実行結果
    APIの実行結果がレスポンス欄に表示されます。
    image376
    図: APIレスポンス