CloudHub API
CloudHub REST API は、Runtime Manager で実行できる多くの操作にプログラムでアクセスする方法を提供します。次の操作を行うことができます。
-
CloudHub のアプリケーションを作成する
-
アプリケーションプロパティ (ワーカーの数や環境変数など) を変更する
-
アプリケーションの新しいバージョンをデプロイする
-
アプリケーションを削除する
-
アプリケーションに関する統計を取得する
-
CloudHub 通知を作成する
-
アプリケーションによってトリガされるメールアラートを作成する
アプリケーションの操作に精通してから、特定の操作を開始してください。
|
この API は、クラウドベースバージョンの Runtime Manager を介したクラウドデプロイメントにのみ対応します。さまざまなデプロイメントシナリオについての詳細は、「デプロイメント戦略」を参照してください。API を介したオンプレミスアプリケーションの管理についてはRuntime Manager API Portal を参照してください。 |
データ形式
型を返すまたは受け入れるリソースやメソッドはすべて、データ形式として JSON を使用します。次に、アプリケーションの取得要求への応答で JSON 形式で受信するデータの例を示します。
{
"domain":"hello",
"fullDomain":"hello.cloudhub.io",
"workers":1,
"hasFile":false,
"muleVersion": "3.1.2",
"properties": {
"foo":"bar"
},
"status":"STARTED",
"workerStatuses":[
{
"id":"",
"host":"xxx.xxx.xxx.xxx",
"port":8081,
"status":"STARTED"
}
]
}API の使用開始と API による認証
API を使用する場合は、任意の HTTP クライアントを使用できます。すべての API はデータ形式として JSON を使用します。Java を使用する場合、JSON 用の Jackson がサポートされている Jersey クライアントまたは HttpClient を使用することをお勧めします。
ユーザ名 (「user@enviornment」形式) でアクセスする環境を制御します。たとえば、ユーザ名が jane で「Development」という環境がある場合、ユーザ名は「jane@Development」になります。環境を指定しない場合、本番環境がデフォルトに設定されます。
状況コードとエラー処理
REST API をコールする場合、次の状況コードが返されます。
| Status Code | 説明 |
|---|---|
200 |
操作に成功した。 |
201 |
リソース (アプリケーションなど) が作成された。場所ヘッダーには、リソースの場所が含まれています。 |
404 |
リソースが見つからなかった。 |
409 |
リソース (サーバ、サーバグループ、デプロイメントなど) の作成時に同じ名前のリソースがすでに存在していた。 |
500 |
操作に失敗した。詳細は、HTTP 本文を参照してください。 |
エラーが発生した場合 (500 状況コードなど)、HTTP 応答には JSON 応答とエラーメッセージが含まれます。例:
500
Content-Type: application/json
Server: Apache-Coyote/1.1
Date: Mon, 10 Aug 2015 00:12:55 GMT
{
message : "Some error message."
}|
サポートされているすべてのリソース、メソッド、必須プロパティ、想定される応答の対話型リファレンスを参照するには、CloudHub API の API Portal を確認してください。 |