This topic describes the GetPreCheckResult API provided by OceanBase Migration Service (OMS).
Purpose
You can call this operation to query the precheck result of a data migration or synchronization task.
Call description
Limitations
This operation is supported in OMS V4.2.2 and later.
Request path
POST /api/v2?Action=GetPreCheckResult
Request parameters
| Parameter | Type | Description |
|---|---|---|
| id | string | The precheck ID, which is the data returned by the SubmitPreCheck API. |
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 ID of the request. |
| pageNumber | integer | The number of the page returned. |
| pageSize | integer | The number of entries returned on each page. |
| totalCount | integer | The total number of entries returned. |
| cost | string | The time spent in processing the request, in seconds. |
| data | object [] | The precheck result. For more information, see the "Parameters in data" section of this topic. |
Parameters in data
| Parameter | Type | Description |
|---|---|---|
| projectId | string | The ID of the data migration or synchronization task. |
| projectStatus | string | The status of the data migration or synchronization task. Valid values: INIT, PENDING, RUNNING, FAILED, FINISHED, and SKIPPED. |
| preCheckResults | object | The result of each precheck item. |
| ├─ name | string | The name of the precheck item, for example, Source-Primary database-Database connectivity check. |
| ├─ endpointType | string | The type of the data source. Valid values: SOURCE and DEST. |
| ├─ checkType | string | The type of the precheck item. |
| ├─ status | string | The status of the precheck item. |
| ├─ message | string | The information about the precheck item. |
| ├─ skippable | boolean | Indicates whether the precheck item is skipped. |
| ├─ role | string | The role of the database. Valid values: Primary Database, Primary Database + Standby Database, and Standby Database. |
| ├─ skipConsequence | string | The consequence of skipping the precheck item. |
| ├─ errorDetail | string | The error message of the precheck item. |
| ├─ removable | boolean | Indicates whether migration or synchronization objects can be removed. |
| ├─ blackObjectsInfo | object | The migration or synchronization objects to be removed. |
| progress | decimal | The progress of the precheck item, in percentage. |
Examples
Request example
{
"id": "t_57p****"
}
Response example
{
"success": true,
"errorDetail": null,
"code": null,
"message": null,
"advice": null,
"requestId": "bf2-9bc9-****",
"pageNumber": null,
"pageSize": null,
"totalCount": null,
"cost": "126 ms",
"data": {
"projectId": "t_57p****",
"projectStatus": "FINISHED",
"preCheckResults": [
{
"name": "Source-Primary database-Database connectivity check",
"endpointType": "SOURCE",
"checkType": "RDB_CONNECT",
"status": "PASSED",
"message": null,
"skippable": false,
"role": "MASTER",
"skipConsequence": null,
"errorDetail": null,
"removable": false,
"blackObjectsInfo": null
},
{
"name": "Source-Primary database-Database existence check",
"endpointType": "SOURCE",
"checkType": "RDB_SCHEMA_EXIST",
"status": "PASSED",
"message": null,
"skippable": false,
"role": "MASTER",
"skipConsequence": null,
"errorDetail": null,
"removable": false,
"blackObjectsInfo": null
}
],
"progress": 100.0
}
}