pause
说明
暂停当前同步操作。
要求
要使用pause端点， mongosync必须处于正在运行状态。
注意
当您配置多个mongosync实例在分片集群之间同步时，您必须向每个mongosync实例发送相同的 API 端点命令。
有关更多信息，请参阅暂停多个 Mongosync。
请求
POST /api/v1/pause
请求正文参数
此端点不使用 HTTP 请求正文参数。 但是，您必须指定带有空对象{ }的--data选项。
响应
字段 | 类型 | 说明 |
|---|---|---|
success | 布尔 | 当请求成功时，该值为 true 。 |
error | 字符串 | 如果发生错误，则指示错误名称。 当 success为true时，响应中将省略此字段。 |
errorDescription | 字符串 | 所发生错误的详细描述。 当 success为true时，响应中将省略此字段。 |
例子
以下示例暂停当前同步操作。
请求
curl localhost:27182/api/v1/pause -XPOST --data '{ }'
响应
{"success":true}
行为
端点保护
mongosync 不保护pause端点。 但是，默认情况下，该 API 仅绑定到本地主机，不接受来自其他来源的调用。 此外， pause调用不会公开连接档案或用户数据。