字段	类型	说明
`state`	字符串	`mongosync`的当前状态。有关可能状态的信息，请参阅状态描述。
`canCommit`	布尔	如果`true` ，则表示提交请求将成功。这也意味着初始同步已完成并正在应用更改事件。
`canWrite`	布尔	如果`true` ，则表示允许在目标集群上进行写入。当`canWrite`为`false`时，请勿写入目标集群。索引验证将持续进行，直到提交完成。
`info`	字符串	提供有关同步进度的额外信息。可能的`info`值包括： `"collection copy"` `"change event application"` `"waiting for commit to complete"` `"commit completed"`
`lagTimeSeconds`	整型	对于`mongosync`的此实例，上次应用的事件与当前最新事件的时间之间的时间（以秒为单位）。注意 `mongosync` 对源集群定期执行无操作写入，这可能会阻止`lagTimeSeconds`字段的值达到零。
`collectionCopy`	对象	估计从collection复制的数据总量以及已复制到目标集群的数据量
`collectionCopy` `.estimatedTotalBytes`	整型	`mongosync`在collection的初始复制期间，所有实例要全局复制的估计字节总数。 `mongosync` 近似迁移前估计的总字节数，并且在同步进程中不会更新该值。此值不反映同步期间对源集群所做的更改，也不是迁移进度的准确指示器。`mongosync` 近似于迁移前的估计总字节数，并且在同步进程中不会更新该值。此值不反映同步期间对源集群所做的更改，也不是迁移进度的准确指示器。
`collectionCopy` `.estimatedCopiedBytes`	整型	`mongosync`在初始collection期间此实例已复制到目标集群的估计字节数。要将总估计进度计算为百分比，请将每个`mongosync`实例的`estimatedCopiedBytes`字段的值相加，然后将结果除以`estimatedTotalBytes`字段的值。然后，将结果乘以 100。由于操作重试，`estimatedCopiedBytes` 的值可能大于 `estimatedTotalBytes` 的值。`estimatedTotalBytes` 和 `estimatedCopiedBytes` 的比较并不能准确反映迁移进度。由于操作重试，`estimatedCopiedBytes` 的值可能大于 `estimatedTotalBytes` 的值。`estimatedTotalBytes` 和 `estimatedCopiedBytes` 的比较并不能准确反映迁移进度。
`directionMapping`	对象	描述同步的映射方向，即源集群和目标集群。
`directionMapping` `.Source`	字符串	源集群。以`<cluster name>: <host>:<port>`形式返回。
`directionMapping` `.Destination`	字符串	目标集群。以`<cluster name>: <host>:<port>`形式返回。
`mongosyncID`	字符串	`mongosync`实例的标识符字符串。
`coordinatorID`	字符串	协调器实例的标识符字符串。当`mongosync`由另一个实例协调时，此字段显示协调器实例的标识符字符串。当`mongosync`为协调器或单独运行时，该字段返回与其`mongosyncID`字段相同的值。当`mongosync`启动时，此字段会返回`null` ，直到`mongosync`识别出协调器。

错误响应

如果mongosync遇到错误， progress端点将返回以下字段：

字段	类型	说明
`error`	字符串	如果发生错误，请提供错误的详细描述。成功调用端点时可省略该字段

行为

当mongosync处于IDLE状态时，除state和canCommit之外的所有输出字段均为null 。
当mongosync处于PAUSED状态时， lagTimeSeconds字段为null 。
端点不会自动刷新。要获取更新后的状态，请再次调用progress端点。
注意
从mongosync 1.7.3开始，恢复或重新启动同步操作时， mongosync可能至少需要两分钟才能响应。在此期间，对progress端点的任何调用都可能失败。如果progress调用失败，可以安全地重试。

端点保护

mongosync 不保护progress端点。但是，默认情况下，该 API 仅绑定到本地主机，不接受来自其他来源的调用。此外， progress调用不会公开连接档案或用户数据。

例子

以下示例返回同步进程的状态。

请求

curl localhost:27182/api/v1/progress -XGET

响应

{
   "progress":
      {
         "state":"RUNNING",
         "canCommit":true,
         "canWrite":false,
         "info":"change event application",
         "lagTimeSeconds":0,
         "collectionCopy":
            {
               "estimatedTotalBytes":694,
               "estimatedCopiedBytes":694
            },
         "directionMapping":
            {
               "Source":"cluster0: localhost:27017",
               "Destination":"cluster1: localhost:27018"
            }
      }
}

后退

开始

来年

暂停

说明

请求

响应

成功响应

注意

错误响应

行为

注意

端点保护

例子

请求

响应