API概览
通过使用DataArts Fabric服务所提供的接口，您可以完整地使用DataArts Fabric服务的基本功能。
服务健康检查
| API | 说明 |
|---|---|
| 查看系统健康状态，用户可通过该接口查看系统健康状态。 |
用户协议管理
| API | 说明 |
|---|---|
| 查询租户协议内容，用户可从中了解协议名称、版本等信息。 | |
| 注册租户协议，用户通过该接口注册租户协议。 | |
| 查询用户是否注册协议。 | |
| 删除用户注册协议。 |
委托管理
| API | 说明 |
|---|---|
| 授权委托给DataArts Fabric服务。用户调用该接口会创建一个委托，该委托会授权给DataArts Fabric服务。用户可以通过传入支持的委托权限策略来可选择的授权。 | |
| 查询授权给DataArts Fabric服务的委托。用户调用该接口查询已授权给DataArts Fabric的委托，以及委托中具体的权限内容。 | |
| 取消授权给DataArts Fabric服务的委托。 |
工作空间管理
| API | 说明 |
|---|---|
| 列举工作空间列表。用户可通过该接口获取符合过滤条件的工作空间列表，接口支持分页查询、支持通过名称、ID和企业项目ID查询。返回为符合过滤条件的工作空间列表。 | |
| 更新工作空间。用户可通过该接口更新工作空间，支持传入名称、描述、MetaStoreID，返回更新后的工作空间详情。 | |
| 创建工作空间。用户可通过该接口创建工作空间，支持传入名称、描述、MetaStoreID、企业项目ID和标签，返回工作空间详情。 | |
| 删除工作空间。在该工作空间下存在计算资源、端点以及App的情况下无法删除，需要先清除该工作空间下创建的各种资源后才能删除。 |
服务规格
| API | 说明 |
|---|---|
| 列举资源规格列表。用户可通过该接口列举资源规格列表，用户可以通过编码、类型、使用场景等参数过滤查询，支持分页。 |
端点管理
| API | 说明 |
|---|---|
| 列举端点列表。用户可使用该接口列举工作空间下端点列表，支持输入模型ID、端点ID、名称、类型、可见性等参数过滤，支持分页查询。 | |
| 创建端点。用户可使用该接口在工作空间下创建端点，输入名称、描述、类型、资源配置、CAP配置等信息，返回端点信息。 | |
| 查询历史语句列表。 | |
| 查询端点详情。用户可通过该接口查询某端点详情，输入为端点ID，返回对应端点详情。 | |
| 查询端点监控，可根据指标名称查询对应的资源使用信息。 | |
| 更新端点。用户可通过该接口更新某端点信息。 | |
| 删除端点。用户可通过该接口删除工作空间下的端点，输入端点ID，返回操作结果。 | |
| 开通端点。用户可通过此接口开通公共端点，输入为端点ID，返回操作结果。 |
模型定义
| API | 说明 |
|---|---|
| 创建模型。用户可通过该接口创建模型，支持传入名称、描述、版本名称、版本描述、基模型类型和模型所在的OBS路径，返回模型ID及其版本ID。 | |
| 列举模型。用户可通过该接口查询模型列表，接口支持分页查询、支持通过名称、ID和类型查询。支持排序。返回为符合过滤条件的模型列表。 | |
| 列举基模型。用户可通过该接口查询基模型列表，接口支持分页查询。返回为符合条件的基模型列表。 | |
| 删除模型的指定版本。如果该版本正在被使用，则无法删除，需要删除使用该模型的推理服务才能删除。用户可通过该接口删除模型版本。 | |
| 更新模型，会生成新版本。通过该接口可以更新模型信息，包括名称、描述、当前版本ID。支持新增版本，支持传入版本名称、描述、基模型类型和模型地址。 | |
| 查询模型的版本列表。用户可通过该接口查询模型版本列表，接口支持分页查询、支持通过名称、ID查询。返回为符合过滤条件的模型版本列表。 | |
| 清理未使用的模型定义。用户可通过该接口删除模型。 |
TMS管理
| API | 说明 |
|---|---|
| 查询项目标签。 | |
| 查询工作空间的标签。用于查询工作空间的标签，返回对应工作空间的标签。 | |
| 通过标签查询工作空间。 | |
| 通过标签查询工作空间数量。 | |
| 工作空间批量添加标签。 | |
| 工作空间批量删除标签。 |
消息管理
| API | 说明 |
|---|---|
| 创建消息通知策略。用户通过调用该接口创建一个消息通知策略。任务执行完成时会将结果根据匹配到的消息通知策略发送消息。 | |
| 查询消息通知策略。用户通过调用该接口查询已创建的消息通知策略。支持分页查询，根据传入的工作空间ID，消息匹配样式来查询。 | |
| 删除消息通知策略。用户通过调用该接口删除已创建的消息通知策略。 |
监控管理
| API | 说明 |
|---|---|
| 更新工作空间下的AOM监控采集配置。 |
接入客户端
| API | 说明 |
|---|---|
| 创建vpcep客户端。VPC打通APIG，使用户可以通过内网域名调用到DataArts Fabric接口。 | |
| 查询接入端列表。用户可以查询到已创建的接入端列表，获取VPCEP内网域名，进行使用。 | |
| 查询接入端详情。用户可以查看接入端的详情。 | |
| 删除接入客户端。用户可以删除不再使用的接入端。 | |
| 更新接入客户端。用户可以修改接入客户端的名字。 |
Service实例管理
| API | 说明 |
|---|---|
| 列举已部署的服务实例列表。用户可通过该接口列举已部署的服务实例列表，接口支持分页查询、支持通过名称、服务实例ID、端点ID、可见性查询。 | |
| 查看部署后的服务实例的详情。返回服务实例的详情信息。 | |
| 部署一个服务实例。部署服务实例接口支持输入名称、描述、端点ID、实例规格、最小值和最大值等参数，返回实例ID。 | |
| 更新已部署的服务实例。用户可以通过该接口更新已部署的服务实例，包括名称和描述等。 | |
| 删除服务实例，释放该实例的资源。 |
推理服务接口
| API | 说明 |
|---|---|
| 调用已部署的大模型推理实例，发起推理请求。 |
Ray Session接口
| API | 说明 |
|---|---|
| 获取Session信息。 |
SQL业务接口
| API | 说明 |
|---|---|
| 创建SQL Session。 | |
| 查询SQL Session列表。 | |
| 查询SQL Session信息。 | |
| 关闭SQL Session。 | |
| 在指定的Session下执行SQL语句。 | |
| 查询SQL语句执行结果。 | |
| 取消SQL语句执行。 | |
| 查询SQL执行记录。 | |
| 查询指定Session下的SQL执行记录。 |
