datai/docs/archive/api-docs/integration/DataiIntegrationRealtimeSyncController/0004-restart-realtime-sync.md

46 lines
1.1 KiB
Markdown
Raw Normal View History

# 重启实时同步服务接口
## 接口信息
- **接口路径**: `/integration/realtime/restart`
- **请求方法**: POST
- **功能描述**: 重启实时同步服务,先停止再启动
- **权限要求**: `integration:realtime:restart`
## 请求参数
| 参数名 | 类型 | 位置 | 必选 | 描述 |
|--------|------|------|------|------|
| 无 | - | - | - | 无请求参数 |
## 响应参数
| 参数名 | 类型 | 描述 |
|--------|------|------|
| success | boolean | 请求是否成功 |
| message | string | 响应消息 |
## 响应示例
```json
{
"success": true,
"message": "实时同步服务重启成功"
}
```
## 错误示例
```json
{
"success": false,
"message": "实时同步服务重启失败: 启动服务时发生异常"
}
```
## 接口说明
1. 该接口用于重启实时同步服务,先停止再启动
2. 重启过程中会重新刷新对象注册表,获取最新的启用实时同步的对象列表
3. 接口需要`integration:realtime:restart`权限才能访问
4. 如果没有权限或发生其他错误,接口会返回失败信息