Salesforce Docs Portal

Runtime Manager REST API

logo server active Private Cloud Edition

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

  • サーバーの管理:

    • サーバーを登録する。

    • 登録済みサーバーのリストを取得する。

    • サーバーに関する情報を取得する。

    • サーバー名を変更する。

    • サーバーをシャットダウン、再起動、削除する。

    • サーバー証明書を更新する。

    • サーバーの登録トークンを取得する。

  • サーバーグループの管理:

    • サーバーのリストからサーバーグループを作成する。

    • 登録済みサーバーグループのリストを取得する。

    • サーバーグループに関する情報を取得する。

    • サーバーグループに名前を付ける。

    • サーバーグループのサーバーを追加または削除する。

    • サーバーグループを削除する。

  • クラスターの管理:

    • クラスターを作成する。

    • 登録済みクラスターのリストを取得する。

    • クラスターに関する情報を取得する。

    • クラスター名を変更する。

    • クラスターのサーバーを追加または削除する。

    • サーバーのクラスタリング情報を変更する。

    • クラスターを削除する。

  • サーバー上のアプリケーションデプロイメントの管理:

    • アプリケーションをデプロイ、再デプロイ、アンデプロイする。

    • アプリケーションのデプロイメントと状況に関する情報を取得する。

    • デプロイ済みアプリケーションのフロー、スケジューラー、アラートを管理する。

API によってサポートされるすべての操作の対話型リファレンスは、 「Runtime Manager REST サービス」​を参照してください。

Runtime Manager REST API マネージャーは、サーバーにデプロイされているオンプレミスアプリケーションのみを管理します。API を使用して CloudHub にデプロイされているアプリケーションを管理する方法は、 「CloudHub API」​を参照してください。

Runtime Manager API の使用

Runtime Manager API の操作にアクセスするには、以下を行う必要があります。

  1. API を使用して認証するには認証ベアラートークン (​AUTH_BEARER_TOKEN​) を生成します。

    アクセストークンを取得するには、組織のシステム管理者ロールが割り当てられたユーザーの Anypoint Platform ユーザー名とパスワードが必要です。 「アクセス管理 API」​の 「認証」​を参照してください。

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

  2. 組織 ID (​ORG_ID​) を取得します。

    「アクセス管理 API」​の /api/me​ エンドポイントを参照してください。

  3. 環境 ID (​ENV_ID​) を取得します。

    「アクセス管理 API」​の /api/organizations/ORG_ID/environments​ORG_ID​ エンドポイントを参照してください。

アプリケーションのリストの取得

Runtime Manager を使用してオンプレミスでデプロイされたアプリケーションのリストを取得するには、次の ​curl​ コマンドを実行します。

curl -X GET \
  --url https://anypoint.mulesoft.com/hybrid/api/v1/applications \
  -H 'authorization: Bearer AUTH_BEARER_TOKEN' \
  -H 'X-ANYPNT-ENV-ID: ENV_ID' \
  -H 'X-ANYPNT-ORG-ID: ORG_ID'

関連情報