红帽全球峰会第 6 章 Fuse Online 公共 REST API 端点参考
本节为每个 Fuse Online 公共 REST API 端点提供参考信息。如需更多信息，请参阅如何调用 Fuse Online 公共 REST API 端点。
在 https://<fuse-online-host>/api/v1/openapi.json 的 Fuse Online 环境中提供了用于定义公共 REST API 端点的 OpenAPI 文档。但是，此文档将 标签对象定义 为带有三个标签： public-api、extensions 和 integration-support。在将 OpenShift 公共 OAuth 代理进程用于 Fuse Online 时，只有 public-api 标签才能被访问。您应该会忽略另外两个标签。
- 第 6.1 节 “获取集成状态的端点”
- 第 6.2 节 “获取集成环境标签列表的端点”
- 第 6.3 节 “标记集成并保持未指定标签的端点”
- 第 6.4 节 “标记集成并删除未指定标签的端点”
- 第 6.5 节 “发布集成的端点”
- 第 6.6 节 “停止集成的端点”
- 第 6.7 节 “用于导出集成的端点”
- 第 6.8 节 “导入集成的端点”
- 第 6.9 节 “从特定集成中删除环境标签的端点”
- 第 6.10 节 “创建环境标签的端点”
- 第 6.11 节 “获取环境标签列表的端点”
- 第 6.12 节 “更改环境标签的端点”
- 第 6.13 节 “用于从所有集成中删除环境标签的端点”
- 第 6.14 节 “更改连接属性的端点”
6.1. 获取集成状态的端点
此端点返回指定集成的状态。状态为 Running、Stopped、Pending 或 Error。
方法和端点
GET
/public/integrations/{id}/state
| 名称 | 类型 | 描述 |
|---|---|---|
| 所需的标头参数 | ||
|
|
| 端点所需的介质类型。 |
|
| Custom | 身份验证需要。 |
|
| Custom | 公开 Fuse Online public REST API 的 OpenShift 服务帐户的 secret 令牌。请参阅 获取 secret 令牌。 |
| 路径参数 | ||
|
| 字符串 | 所需的路径参数。您要获取的集成的名称或内部 ID。请参阅 如何查找集成 ID。 |
请求示例
在以下示例中，端点返回 timer-to-log 集成的状态：
/public/integrations/timer-to-log/state
produces
application/json
响应示例
{"currentState":"Unpublished","stateDetails":{"id":"i-Lc0JLrsUFtBJfR_ylfEz:5","integrationId":"i-Lc0JLrsUFtBJfR_ylfEz","deploymentVersion":5,"detailedState":{"value":"BUILDING","S tep":2,"totalSteps":4},"namespace":"syndesis","podName":"i-timer-to-log-5-build","linkType":"LOGS"}}'
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}