---
title: "查询任务的进度 | OceanBase 文档中心"
description: 查询任务的进度 本文为您介绍 OceanBase 迁移服务（OceanBase Migration Service，OMS）社区版提供的 OpenAPI：查询任务的进度 DescribeProjectProgress。 功能说明 本接口用于查询数据迁移或数据同步任务的进度信息。 调用说明 接口约束 本接口适用于 OM…
---
切换语言

- 中文站 - 简体中文
- International - English
- 日本站 - 日本語

文档反馈![](https://mdn.alipayobjects.com/huamei_22khvb/afts/img/A*L03BS6f-o40AAAAAAAAAAAAADiGDAQ/original) 迁移服务 OMSV 4.2.8 社区版

# 查询任务的进度

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

[编辑](https://github.com/oceanbase/oms-doc/edit/V4.2.8/zh-CN/1200.reference-guide/100.api-reference/1200.describe-project-progress.md)  

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

## 功能说明

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

## 调用说明

### 接口约束

本接口适用于 OMS 社区版 V4.1.1-CE 及之后版本。

### 请求路径

`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，单位为秒。 |

## 示例

### 请求示例

```JSON
{
  "id": "np_4w****"
}

```

### 返回示例

```JSON
{
    "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
    }
}

```

 上一篇 下一篇 ![有帮助](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*y6ocSqN8cqsAAAAAAAAAAAAAARQnAQ)![无帮助](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*BG9IQJyLHF8AAAAAAAAAAAAAARQnAQ)![反馈](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*eTWdQKCRKHwAAAAAAAAAAAAAARQnAQ)[AI](https://www.oceanbase.com/obi) 咨询热线