Skip to content

服务目录查询 API

面向登录用户读取服务目录、可用 provider 和默认服务选择。

基础信息

  • 基础路径/services
  • 认证方式:JWT Bearer Token 或 API Key(combinedAuth)。

端点

补充端点

本节补充 plans/need-update-api.md 中尚未覆盖到 docs-site 的接口。端点标题保持严格的 METHOD /path 格式,便于后台文档覆盖率服务识别。

GET /services/defaults/:serviceType

读取指定服务类型的默认 Provider / Offering。

认证:JWT Bearer Token 或 API Key(combinedAuth)。 路径参数

参数说明
serviceType服务类型

请求:无请求体。Query 参数用于分页、过滤、搜索或状态筛选;未传时按后端默认排序与分页返回。

响应:成功时返回目标资源详情、状态或配置对象。

常见错误400 参数非法,401 未认证,403 权限不足,404 资源不存在;服务端或上游异常返回 500


GET /services/offerings

读取当前可用服务目录。

认证:JWT Bearer Token 或 API Key(combinedAuth)。 请求:无请求体。Query 参数用于分页、过滤、搜索或状态筛选;未传时按后端默认排序与分页返回。

响应:成功时返回目标资源详情、状态或配置对象。

常见错误400 参数非法,401 未认证,403 权限不足,404 资源不存在;服务端或上游异常返回 500


GET /services/providers

读取当前可用服务 Provider。

认证:JWT Bearer Token 或 API Key(combinedAuth)。 请求:无请求体。Query 参数用于分页、过滤、搜索或状态筛选;未传时按后端默认排序与分页返回。

响应:成功时返回目标资源详情、状态或配置对象。

常见错误400 参数非法,401 未认证,403 权限不足,404 资源不存在;服务端或上游异常返回 500

AI Workflow Editor