datai/docs/archive/api-docs/integration/RealtimeServiceController/0015-stop-all.md

一键停止所有实时服务

接口概述

一键停止所有 Salesforce 实时服务，包括实时同步服务和事件订阅服务，按顺序依次停止。

接口详情

• 接口名称: 一键停止所有实时服务
• 接口路径: /integration/realtime/service/stop/all
• 请求方法: POST
• 权限标识: integration:realtime:stop:all
• 接口标签: 【实时服务管理】统一管理

请求参数

Headers

参数名	类型	必填	描述
Authorization	String	是	认证令牌，格式：Bearer {token}
Content-Type	String	是	请求内容类型，固定值：application/json

Query Parameters

无

Body Parameters

无

响应参数

响应结构

{
  "success": boolean,
  "message": String,
  "details": {
    "realtimeSyncService": String,
    "eventSubscriber": String
  }
}

字段说明

字段名	类型	描述
success	Boolean	请求是否成功，true-成功，false-失败
message	String	响应消息，描述操作结果
details	Object	各服务停止详情
details.realtimeSyncService	String	实时同步服务停止详情
details.eventSubscriber	String	事件订阅服务停止详情

响应示例

成功响应

{
  "success": true,
  "message": "所有实时服务停止成功",
  "details": {
    "realtimeSyncService": "停止成功",
    "eventSubscriber": "停止成功"
  }
}

失败响应

{
  "success": false,
  "message": "停止所有实时服务失败: 服务异常",
  "details": {
    "realtimeSyncService": "停止成功",
    "eventSubscriber": "停止失败"
  }
}

错误码说明

错误码	描述	解决方案
401	未授权，token 无效或已过期	重新登录获取有效 token
403	无权限访问该接口	联系管理员分配相应权限
500	服务器内部错误	检查服务器日志，联系技术支持

注意事项

1. 停止顺序为：实时同步服务 → 事件订阅服务
2. 停止操作不会影响已接收但尚未处理的事件，这些事件将继续被处理
3. 停止操作不会清空对象注册表，已注册的对象配置仍保留
4. 如果服务未在运行，再次调用此接口不会产生副作用
5. 停止成功后，系统将不再接收和处理来自 Salesforce 的实时变更事件
6. 停止操作是幂等的，可以安全地重复执行
7. 建议在以下场景使用一键停止：
   • 系统维护期间
   • 需要暂停所有实时同步功能时
   • 配置更新前需要先停止服务
   • 故障排查或性能调优时
   • 数据库维护或迁移时
8. 停止所有服务后，如需重新启动，请使用一键启动所有实时服务接口
9. 停止服务后，统计信息仍可查询，但不会继续更新

相关接口

• 获取服务状态
• 一键启动所有实时服务
• 停止实时同步服务
• 停止事件订阅