查询项目的进度 | OceanBase 文档中心

查询项目的进度

更新时间：2023-08-18 09:52:19

本文为您介绍 OceanBase 迁移服务（OceanBase Migration Service，OMS）提供的 OpenAPI：查询项目的进度 DescribeProjectProgress。

功能说明

本接口用于查询数据迁移或数据同步项目的进度信息。

调用说明

接口约束

本接口适用于 OMS 4.1.0 及以上版本。

请求路径

POST /api/v2?Action=DescribeProjectProgress

请求参数

参数	类型	描述
id	string	数据迁移或数据同步项目的 ID。

返回结果

参数	类型	描述
success	boolean	是否调用成功。
errorDetail	object	错误详情。
code	string	错误码。
message	string	描述信息。
advice	string	建议。
requestId	string	请求 ID。
pageNumber	integer	页序号，分页查询时生效。
pageSize	integer	页大小，分页查询时生效。
totalCount	integer	总数，分页查询时生效。
cost	string	请求耗时，单位为秒。
data	string	项目进度的相关信息。
├─ projectId	string	项目的 ID。
├─ status	string	通用的项目状态枚举，包括 INIT（未启动）、RUNNING（运行中）、SUSPEND（暂停中）、FAILED（已失败）、FINISHED（已完成）、RELEASING（释放中）、RELEASED（已释放）、DELETED（已删除）、RUNNING_MODIFYING（修改中）和 RUNNING_MERGING（合并中）。
├─ alarmLevel	string	告警级别，包括 HIGH（高保护）、MEDIUM（中保护）、LOW（低保护）和 IGNORE（无保护）。
├─ enableIncrSync	boolean	是否有正向增量同步。
├─ currentStep	string	当前项目运行所处的步骤。
├─ incrSyncCheckpoint	integer	正向增量同步位点。当源端为 DB2 LUW、OceanBase、MySQL 或 Oracle 数据库时，格式均为 Unix timestamp，单位为秒。
├─ enableStructTransfer	boolean	是否有结构传输。
├─ enableFullTransfer	boolean	是否有全量数据传输。
├─ structTransferProgress	integer	结构传输进度的百分比。
├─ fullTransferProgress	integer	全量传输进度的百分比。
├─ enableReverseIncrTransfer	boolean	是否有反向增量同步。
├─ reverseIncrTransferCheckpoint	integer	反向增量同步位点。格式为 Unix timestamp，单位为秒。

示例

请求示例

{
  "id": "np_4w****"
}

返回示例

{
    "success":true,
    "errorDetail":null,
    "code":null,
    "message":null,
    "advice":null,
    "requestId":"xfez****",
    "pageNumber":1,
    "pageSize":5,
    "totalCount":50,
    "cost":"27 ms",
    "data":{
        "projectId":"np_4w****",
        "status":"RUNNING",
        "alarmLevel":"MEDIUM",
        "enableIncrSync":true,
        "currentStep":"PRE_CHECK",
        "incrSyncCheckpoint":1689248064,
        "enableStructTransfer":true,
        "enableFullTransfer":true,
        "structTransferProgress":100,
        "fullTransferProgress":100,
        "enableReverseIncrTransfer":true,
        "reverseIncrTransferCheckpoint":1689248075
    }
}