This topic describes the OceanBase Migration Service (OMS) API operation of obtaining the status of a synchronization project.
Description
You can call this operation to obtain the status of a data synchronization project based on the specified parameters.
Call description
Prerequisites
This operation is applicable to OMS V3.3.0.
Request path
GET api/omsp/v2/sync/{projectId}/progress
Request parameters
| Parameter | Type | Description |
|---|---|---|
| projectId | String | The ID of the data synchronization project. |
Response parameters
| Parameter | Type | Description |
|---|---|---|
| success | Boolean | Indicates whether the call is successful. |
| code | String | The status code. |
| message | String | The description. |
| advice | String | The advice. |
| requestId | String | The request ID. |
| pageNumber | Integer [int32] | The current page number. |
| pageSize | Integer [int32] | The number of records per page. |
| totalCount | Integer [int64] | The total number of records. |
| cost | String | The time spent on processing the request. |
| data | Object | For more information, see Parameters in data. |
Parameters in data:
| Parameter | Type | Description |
|---|---|---|
| status | String | The status of the data synchronization project. Valid values: INIT, RUNNING, SUSPEND, FAILED, FINISHED, RELEASING, RELEASED, and DELETED. |
| importance | String | The alert level. Valid values: HIGH, MEDIUM, LOW, and IGNORE. |
| enableStructSync | Boolean | Indicates whether structure synchronization is enabled. |
| enableFullSync | Boolean | Indicates whether full data synchronization is enabled. |
| enableIncrSync | Boolean | Indicates whether incremental synchronization is enabled. |
| currentStep | String | The current step. |
| structMigrationProgress | Integer [int32] | The progress of structure migration in percentage. Value range: 0 to 100. |
| fullMigrationProgress | Integer [int32] | The progress of full migration in percentage. Value range: 0 to 100. |
| incrSyncCheckpoint | String | The checkpoint for incremental synchronization. The value format depends on the type of the source database. Three formats are available now. If the source is not a Sybase or GeaBase database, the value can be converted into an integer Unix timestamp, in seconds. |
Sample response
{
"success":true
"code":"success"
"message":"sbjve****"
"advice":"ikxwe****"
"requestId":"817dfA6B-****."
"pageNumber":194
"pageSize":4176
"totalCount":6755
"cost":"xgojy****"
"data":{
"status":"INIT"
"importance":"HIGH"
"enableStructSync":true
"enableFullSync":true
"enableIncrSync":true
"currentStep":"PRE_CHECK"
"structSyncProgress":842
"fullSyncProgress":1247
"incrSyncCheckpoint":"vdhmpliedmbfs****"
}
}
