This topic describes the DescribeProjectProgress API provided by OceanBase Migration Service (OMS).
Purpose
You can call this operation to query the progress information about a data migration or synchronization task.
Call description
Limitations
This operation is supported in OMS V4.1.0 and later.
Request path
POST /api/v2?Action=DescribeProjectProgress
Request parameters
| Parameter | Type | Description |
|---|---|---|
| id | string | The ID of the data migration or synchronization task. |
Response parameters
| Parameter | Type | Description |
|---|---|---|
| success | boolean | Indicates whether the call is successful. |
| errorDetail | object | The error details. |
| code | string | The error code. |
| message | string | The error description. |
| advice | string | The suggestions about how to resolve the error. |
| requestId | string | The request ID. |
| pageNumber | integer | The number of the page to return. |
| pageSize | integer | The number of entries to return on each page. |
| totalCount | integer | The total number of entries returned. |
| cost | string | The time spent in processing the request, in seconds. |
| data | string | The progress information about the task. |
| ├─ projectId | string | The task ID. |
| ├─ status | string | The task status. Valid values: INIT, RUNNING, SUSPEND, FAILED, FINISHED, RELEASING, RELEASED, DELETED, RUNNING_MODIFYING, and RUNNING_MERGING. |
| ├─ alarmLevel | string | The alert level. Valid values: HIGH (high-level protection), MEDIUM (medium-level protection), LOW (low-level protection), and IGNORE (no protection). |
| ├─ enableIncrSync | boolean | Indicates whether incremental synchronization is enabled. |
| ├─ currentStep | string | The current step of the task. |
| ├─ incrSyncCheckpoint | integer | The timestamp for forward incremental synchronization. When the source data source is a DB2 LUW, OceanBase, MySQL, or Oracle database, the value is a Unix timestamp in seconds. |
| ├─ enableStructTransfer | boolean | Indicates whether schema migration is enabled. |
| ├─ enableFullTransfer | boolean | Indicates whether full migration is enabled. |
| ├─ structTransferProgress | integer | The schema migration progress in percentage. |
| ├─ fullTransferProgress | integer | The full migration progress in percentage. |
| ├─ enableReverseIncrTransfer | boolean | Indicates whether reverse incremental synchronization is enabled. |
| ├─ reverseIncrTransferCheckpoint | integer | The timestamp for reverse incremental synchronization. The value is a Unix timestamp in seconds. |
Examples
Sample request
{
"id": "np_4w****"
}
Sample response
{
"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
}
}