1.2. API情報 ( Cloudn Compute FLATタイプ)

本サービスにて提供しているAPI Server (End Point)のURIは下記となります。

CloudStack API Endpoint
リージョン URL
東日本 https://comp-api.jp-e1.cloudn-service.com/client/api
西日本 https://comp-api.jp-w1.cloudn-service.com/client/api
米国 https://comp-api.us-e1.cloudn-service.com/client/api
AWS互換API Endpoint
リージョン URL
東日本 https://comp-apia.jp-e1.cloudn-service.com/awsapi
西日本
米国 https://comp-apia.us-e1.cloudn-service.com/awsapi

注釈

西日本リージョンはAWS互換API未対応です。

以下のテーブルは後述のAPI Requestにおいて用いる共通のパラメータを示しています。

Common Request Parameter
パラメータ名 説明 必須
apikey アクセスキーID (※1) Yes
command APIメソッドを指定する Yes
signature リクエストに対する電子署名情報を指定する Yes
response 値に、”json”を指定することで、responseをXMLからjson 形式に変更する No
expires APIリクエストの有効期限を指定する。指定方法は、strftime(3)の書式で、”%Y-%m-%dT%T%z”で指定(※1) No
signatureVersion “3”を指定する (※1) No

注釈

(※1). expires と signatureVersionを用いる場合は同時に指定する必要があります。

下記にAsynchronous(非同期)APIの共通レスポンス形式を示します。

Common Response (Asynchronous Methods)
Node名 説明 子Node
“非同期メソッド名”response レスポンスコンテナ jobid
jobid 非同期メソッドをコールし、 ジョブとして登録された際に払い出されたjobid  

注釈

非同期メソッドを実行した際のレスポンスは、非同期メソッドにより、jobidを格納するコンテナの値が変わります。たとえば、”deployVirtuamMachine”メソッドを実行した場合、そのレスポンスコンテナは、”deployvirtualmachineresponse”となります。

[参考]前提知識

Cloudn Computeについて

Cloudn Computeの操作・機能については操作マニュアルを参照してください。

クラウド・エヌ インフォメーションポータル - マニュアル

APIの利用方法について

APIを利用するには、クライアントと呼ばれるツールを利用する方法、
もしくはお客様プログラム上において仕様にしたがってAPIを利用する方法が一般的です。

以下、APIクライアントを利用した利用例・プログラム上でAPIを利用するために必要なリクエストの作成例を示します。

注釈

APIのご利用にあたっては、ご利用前に、 Cloudn ポータルより サービスを「利用中」の状態にする必要があります。