获取迁移项目状态 | OceanBase 文档中心

获取迁移项目状态

更新时间：2026-04-14 15:40:46

编辑

本文为您介绍 OMS 社区版提供的 OpenAPI：获取迁移项目状态。

功能说明

本接口用于根据用户指定的参数获取数据迁移项目的状态。

接口说明

接口约束

本接口适用于 OMS 社区版 3.3.0-CE 及以上版本。

请求路径

GET /api/omsp/v2/migrations/{projectId}/progress

请求参数

参数	类型	描述
projectId	string	数据迁移项目的 ID。

返回结果

参数	类型	描述
success	boolean	是否调用成功。
code	string	状态码。
message	string	描述信息。
advice	string	建议。
requestId	string	请求 ID。
pageNumber	integer[int32]	当前页数。
pageSize	integer[int32]	每页条数。
totalCount	integer[int64]	总记录数。
cost	string	请求耗时。
data	Object	具体包含的信息请参见《data 数据结构》。

data 数据结构：

参数	类型	描述
status	string	数据迁移项目的类型。取值包括 INIT、RUNNING、SUSPEND、FAILED、FINISHED、RELEASING、RELEASED 和 DELETED。
importance	string	告警保障等级，取值包括 HIGH、MEDIUM、LOW 和 IGNORE。
enableStructMigration	boolean	是否有结构迁移。
enableFullMigration	boolean	是否有全量数据迁移。
enableIncrSync	boolean	是否有正向增量同步。
enableReverseIncrSync	boolean	是否有反向增量同步。
currentStep	string	当前进行到的步骤，不包括全量校验。
structMigrationProgress	integer[int32]	结构迁移进度百分比，0~100。
fullMigrationProgress	integer[int32]	全量迁移进度百分比，0~100。
incrSyncCheckpoint	integer[int64]	正向增量同步位点，单位为秒。
reverseIncrSyncCheckpoint	integer[int64]	反向增量同步位点，单位为秒。

请求示例

$curl http://xxx.xxx.xxx.1:8089/api/omsp/v2/migrations/p_3xj9****/progress -H 'Authorization: Basic aGV****'

返回示例

{
    "success": true,
    "errorDetail": null,
    "code": null,
    "message": null,
    "advice": null,
    "requestId": null,
    "pageNumber": null,
    "pageSize": null,
    "totalCount": null,
    "cost": "13 ms",
    "data": {
        "status": "RUNNING",
        "importance": "LOW",
        "enableStructMigration": true,
        "enableFullMigration": true,
        "enableIncrSync": true,
        "enableReverseIncrSync": true,
        "currentStep": "REVERSE_INCR_SYNC",
        "structMigrationProgress": 100,
        "fullMigrationProgress": 100,
        "incrSyncCheckpoint": 1661166286,
        "reverseIncrSyncCheckpoint": 1661239332
    }
}