第 7 章 Fuse Online 公共 REST API 端点参考
本节提供了每个 Fuse 在线公共 REST API 端点的参考信息。如需更多信息，请参阅如何调用 Fuse Online 公共 REST API 端点。
在 https://<fuse-online-host>/api/v1/openapi.json 的 Fuse Online 环境中提供了定义公共 REST API 端点的 OpenAPI 文档。但是，本文档将 tags 对象定义为有三个标签： public-api、extension 和 integration-support。对于 Fuse Online，只有使用 OpenShift 公共 OAuth 代理进程时，只能访问 public-api 标签。您应该忽略另外两个标签。
- 第 7.1 节 “获取集成状态的端点”
- 第 7.2 节 “获取集成环境标签列表的端点”
- 第 7.3 节 “用于标记集成并保留未指定标签的端点”
- 第 7.4 节 “用于标记集成和删除未指定标签的端点”
- 第 7.5 节 “用于发布集成的端点”
- 第 7.6 节 “用于停止集成的端点”
- 第 7.7 节 “用于导出集成的端点”
- 第 7.8 节 “用于导入集成的端点”
- 第 7.9 节 “从特定集成中删除环境标签的端点”
- 第 7.10 节 “用于创建环境标签的端点”
- 第 7.11 节 “获取环境标签列表的端点”
- 第 7.12 节 “用于更改环境标签的端点”
- 第 7.13 节 “从所有集成中删除环境标签的端点”
- 第 7.14 节 “用于更改连接属性的端点”
7.1. 获取集成状态的端点
此端点返回指定集成的状态。状态为 Running、Stopped、Pending 或 Error。
方法和端点
GET
/public/integrations/{id}/state
| Name | 类型 | 描述 |
|---|---|---|
| 所需的标头参数 | ||
|
|
| 端点所需的介质类型。 |
|
| Custom | 身份验证需要。 |
|
| Custom | 公开 Fuse Online 公共 REST API 的 OpenShift 服务帐户的 secret 令牌。请参阅 获取 secret 令牌。 |
| 路径参数 | ||
|
| 字符串 | 所需的 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"}}'
