第6章 Fuse Online のパブリック REST API エンドポイントの参照情報

このセクションでは、Fuse Online の各パブリック REST API エンドポイントについての参照情報を紹介します。詳細は、Fuse Online パブリック REST API エンドポイントの呼び出し方法 を参照してください。

パブリック REST API エンドポイントを定義する OpenAPI ドキュメントは https://<fuse-online-host>/api/v1/openapi.json の Fuse Online 環境にて利用できます。ただし、本ドキュメントでは tags オブジェクトに 3 つのタグ (public-api、extensions、integration-support) があると定義しています。Fuse Online の OpenShift パブリック OAuth プロキシープロセスの使用時は、public-api タグのみにアクセスできます。他の 2 つのタグは無視する必要があります。

6.1. インテグレーションの状態を取得するためのエンドポイント

このエンドポイントは、指定されたインテグレーションの状態を返します。状態には Running、Stopped、Pending、または Error があります。

メソッドとエンドポイント

GET

/public/integrations/{id}/state

表6.1 パラメーター

名前タイプ説明

必須のヘッダーパラメーター

-H "Content-Type: <media-type>"

application/json

エンドポイントが必要とするメディアタイプ。

-H "SYNDESIS-XSRF-TOKEN: awesome"

カスタム

認証に必要です。

-H 'Authorization: Bearer <token> '

カスタム

Fuse Online のパブリック REST API を公開する OpenShift サービスアカウントのシークレットトークン。パブリック REST API エンドポイントを呼び出すためのシークレットトークンの取得 を参照してください。

パスパラメーター

{id}

文字列

必須のパスパラメーター。状態を取得するインテグレーションの名前または内部 ID。インテグレーション ID の検索方法 を参照してください。

リクエストの例

以下の例では、エンドポイントは timer-to-log インテグレーションの状態を返します。

/public/integrations/timer-to-log/state

生成されるもの

application/json

応答の例

{"currentState":"Unpublished","stateDetails":{"id":"i-Lc0JLrsUFtBJfR_ylfEz:5","integrationId":"i-Lc0JLrsUFtBJfR_ylfEz","deploymentVersion":5,"detailedState":{"value":"BUILDING","currentStep":2,"totalSteps":4},"namespace":"syndesis","podName":"i-timer-to-log-5-build","linkType":"LOGS"}}`これまで