CloudHub REST API

CloudHub REST API を使用すると、Anypoint Runtime Manager の次の機能にプログラムでアクセスできます。

アプリケーションの管理:
- CloudHub でアプリケーションを作成、デプロイ、開始、終了、リスト、削除する
- ワーカー数、Mule Runtime Engine バージョン、システムプロパティなどのアプリケーションのメタデータを更新する
- アプリケーションやワーカーの統計情報を取得する
- アプリケーションのトランザクションやトランザクションのイベントを取得する
- 再生データを確認し、トランザクションのフローを再生して、アプリケーションの再生データを削除する
- 静的 IP アドレスを管理して、アプリケーションに関連付けられている未使用の IP アドレスを解放する
- アプリケーションの Mule パッケージをダウンロードする
- スケジュールの全部または一部を更新、有効化、無効化、または実行する
ログ、通知、アラートの管理:
- アプリケーションのログレベルを追加、更新、取得する
- アプリケーションまたはインスタンスのログファイルをダウンロードする
- 通知を作成、更新、取得する
- 通知を既読または未読としてマークする
- アプリケーションによってトリガされるアラートを作成、更新、削除する
- アラートとアラート履歴を取得する
ロードバランサの管理:
- ロードバランサを作成、更新、削除する
- 組織内のロードバランサをリストする
- ロードバランサルールをテストして、入力に適用されるルールの数を返す
VPC と VPN の管理
- VPC を作成、更新、リスト、削除する
- VPN 接続を作成、削除する
永続的なキューの管理:
- 永続的なキューの統計情報を取得する
- 永続的なキューあkらエントリをクリアする
以下に関する追加情報を取得する:
- サポート対象の Mule バージョン
- 現在の組織 (使用状況の統計情報を含む)
- ワーカー (スレッドダンプとワーカー領域を含む)
- ユーザ (権限を含む)
- 使用可能なドメイン名

サポートされているリソース、メソッド、必須プロパティ、予想される応答の対話型リファレンスについては、CloudHub API Portal を参照してください。

CloudHub API は、クラウドベースバージョンの Runtime Manager にデプロイされたアプリケーションのみを管理します。 API を使用したオンプレミスアプリケーションの管理については、「Runtime Manager REST サービス」を参照してください。

API の使用開始と API による認証

アプリケーションの操作に慣れてから開始してください。

CloudHub API ではどの HTTP クライアントでも使用できます。 Java を使用する場合は、JSON 用の Jackson がサポートされている Jersey クライアントまたは HttpClient を使用してください。

CloudHub API にアクセスするには、最初に Anypoint Platform で認証が必要です。認証には、アクセス管理 API を使用します。認証では、Authorization ヘッダーでアクセストークンを指定する必要があります。詳細は、「Authentication (認証)」を参照してください。

ユーザ名により、アクセスする環境が指定されます。たとえば、ユーザ名が jane で、Development という環境がある場合、ユーザ名は jane@Development になります。環境を指定しない場合の API のデフォルトは Production です。

データ形式

型を返すまたは受け入れるリソースやメソッドは、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"
     }
   ]
}

状況コードとエラー処理

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 REST API

API の使用開始と API による認証

データ形式

状況コードとエラー処理

関連情報