This topic describes the DescribeProjectProgress operation provided by OceanBase Migration Service (OMS).
Purpose
You can call this operation to query the progress of 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, synchronization, or verification 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. |
| requestId | string | The ID of the request. |
| pageNumber | integer | The number of the page returned, which takes effect in a pagination query. |
| pageSize | integer | The number of entries returned on each page, which takes effect in a pagination query. |
| totalCount | integer | The total number of pages returned, which takes effect in a pagination query. |
| cost | string | The time spent in processing the request, in seconds. |
| Data | string | The information about the progress of the task. |
| ├─ projectId | string | The ID of the task. |
| ├─ status | string | The general states of the task. Valid values: INIT, RUNNING, SUSPEND, FAILED, FINISHED, RELEASING, RELEASED, DELETED, RUNNING_MODIFYING, and RUNNING_MERGING. |
| ├─ alarmLevel | string | The alert-based protection level. Valid values: HIGH, MEDIUM, LOW, and IGNORE. |
| ├─ enableIncrSync | boolean | Indicates whether incremental synchronization is enabled. |
| ├─ currentStep | string | The current step of the task. |
| ├─ incrSyncCheckpoint | integer | The start timestamp for incremental synchronization. If the source is of the Db2 for LUW, OceanBase, MySQL, or Oracle type, 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 progress percentage of schema migration. |
| ├─ fullTransferProgress | integer | The progress percentage of full migration. |
| ├─ enableReverseIncrTransfer | boolean | Indicates whether reverse increment is enabled. |
| ├─ reverseIncrTransferCheckpoint | integer | The start timestamp for reverse increment. The value is a Unix timestamp in seconds. |
Examples
Request example
{
"id": "np_4w****"
}
Response example
{
"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
}
}
