第 6 章 Fuse Online 公共 REST API 端点参考

本节提供了每个 Fuse 在线公共 REST API 端点的参考信息。如需更多信息,请参阅如何调用 Fuse Online 公共 REST API 端点

https://<fuse-online-host>/api/v1/swagger.json 的 Fuse Online 环境中提供了定义公共 REST API 端点的 OpenAPI 文档。但是,本文档将 tags 对象定义为有三个标签: public-apiextensionintegration-support。对于 Fuse Online,只有使用 OpenShift 公共 OAuth 代理进程时,只能访问 public-api 标签。您应该忽略另外两个标签。

6.1. 获取集成状态的端点

此端点返回指定集成的状态。状态为 RunningStoppedPendingError

方法和端点

GET

/public/integrations/{id}/state

表 6.1. 参数

Name类型描述

所需的标头参数

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

application/json

端点所需的介质类型。

-h "SYNDESIS-XSRF-TOKEN: awesome"

Custom

身份验证需要。

-h 'Authorization: Bearer <token> '

Custom

公开 Fuse Online 公共 REST API 的 OpenShift 服务帐户的 secret 令牌。请参阅 获取 secret 令牌

路径参数

{id}

字符串

所需的 path 参数。要获取集成的名称或内部 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"}}'