datai/docs/archive/api-docs/integration/DataiIntegrationRealtimeSyncController/0003-stop-realtime-sync.md

1.1 KiB
Raw Blame History

停止实时同步服务接口

接口信息

  • 接口路径: /integration/realtime/stop
  • 请求方法: POST
  • 功能描述: 停止实时同步服务停止订阅Salesforce Change Events
  • 权限要求: integration:realtime:stop

请求参数

参数名 类型 位置 必选 描述
- - - 无请求参数

响应参数

参数名 类型 描述
success boolean 请求是否成功
message string 响应消息

响应示例

{
  "success": true,
  "message": "实时同步服务停止成功"
}

错误示例

{
  "success": false,
  "message": "实时同步服务停止失败: 服务未启动"
}

接口说明

  1. 该接口用于停止实时同步服务停止订阅Salesforce Change Events
  2. 停止过程中会取消所有事件订阅并关闭Salesforce连接
  3. 接口需要integration:realtime:stop权限才能访问
  4. 如果没有权限或发生其他错误,接口会返回失败信息