This topic describes the GetPreCheckResult API provided by OceanBase Migration Service (OMS) Community Edition.
Overview
You can call this operation to query the details of a precheck.
API details
Constraints
This API is applicable to OMS Community Edition V4.2.12-CE and later.
Request path
POST /api/v2?Action=GetPreCheckResult
Request parameters
| Parameter | Type | Description |
|---|---|---|
| id | string | The ID of the precheck task. |
Response parameters
| Parameter | Type | Description |
|---|---|---|
| success | boolean | Indicates whether the call was successful. |
| errorDetail | object | The error details. |
| code | string | The error code. |
| message | string | The description. |
| advice | string | The recommendation. |
| requestId | string | The request ID. |
| pageNumber | integer | The page number. This parameter takes effect only when you perform a paginated query. |
| pageSize | integer | The number of entries per page. This parameter takes effect only when you perform a paginated query. |
| totalCount | integer | The total number of entries. This parameter takes effect only when you perform a paginated query. |
| cost | string | The time consumed by the request, in seconds. |
| data | object | The information about the precheck task. For more information, see the data structure described in the following table. |
Data structure
Parameter Type Description preCheckId string The ID of the precheck task. preCheckStatus string The status of the precheck task. Valid values: INIT(initializing),PENDING(not started),RUNNING(running),FAILED(failed), andFINISHED(completed).progress double The progress of the precheck task. preCheckResults array The list of precheck tasks. ├─ name string The name of the precheck task. ├─ endpointType string The endpoint of the precheck task. Valid values: SOURCE(source) andDEST(destination).├─ checkType string The type of the precheck task. ├─ status string The status of the precheck task. Valid values: PENDING(not started),RUNNING(running),FAILED(failed during execution),WARNING(passed but not successful), andPASSED(successful).
Examples
Request example
{
"id": "t_7di****"
}
Response example
{
"success": true,
"errorDetail": null,
"code": null,
"message": null,
"advice": null,
"requestId": "30f1584a-f34b-429e-98f9-8f0766324bdd",
"pageNumber": null,
"pageSize": null,
"totalCount": null,
"cost": "138 ms",
"data": {
"preCheckId": "t_7di1uvmxd340",
"preCheckStatus": "FINISHED",
"preCheckResults": [
{
"name": "OMS server resource check",
"endpointType": "SOURCE",
"checkType": "OMS_RESOURCE",
"status": "PASSED",
"message": null,
"skippable": false,
"role": "MASTER",
"skipConsequence": null,
"errorDetail": null,
"removable": false,
"blackObjectsInfo": null
},
{
"name": "Connectivity check between the source database and the primary database",
"endpointType": "SOURCE",
"checkType": "RDB_CONNECT",
"status": "PASSED",
"message": null,
"skippable": false,
"role": "MASTER",
"skipConsequence": null,
"errorDetail": null,
"removable": false,
"blackObjectsInfo": null
},
{
"name": "Incremental log check for the primary database",
"endpointType": "SOURCE",
"checkType": "DB_INCR_LOG",
"status": "PASSED",
"message": null,
"skippable": false,
"role": "MASTER",
"skipConsequence": null,
"errorDetail": null,
"removable": false,
"blackObjectsInfo": null
},
{
"name": "Database clock synchronization check for the primary database",
"endpointType": "SOURCE",
"checkType": "DB_TIME_SYNC",
"status": "PASSED",
"message": null,
"skippable": false,
"role": "MASTER",
"skipConsequence": null,
"errorDetail": null,
"removable": false,
"blackObjectsInfo": null
},
{
"name": "Database version check for the primary database",
"endpointType": "SOURCE",
"checkType": "DB_VERSION",
"status": "PASSED",
"message": null,
"skippable": true,
"role": "MASTER",
"skipConsequence": null,
"errorDetail": null,
"removable": false,
"blackObjectsInfo": null
},
{
"name": "Existence check for the primary database",
"endpointType": "SOURCE",
"checkType": "RDB_SCHEMA_EXIST",
"status": "PASSED",
"message": null,
"skippable": false,
"role": "MASTER",
"skipConsequence": null,
"errorDetail": null,
"removable": false,
"blackObjectsInfo": null
},
{
"name": "Write permission check for the primary database account",
"endpointType": "SOURCE",
"checkType": "DB_ACCOUNT_WRITER_PRIVILEGE",
"status": "PASSED",
"message": null,
"skippable": false,
"role": "MASTER",
"skipConsequence": null,
"errorDetail": null,
"removable": false,
"blackObjectsInfo": null
},
{
"name": "Source-Master-Consistency Check of Table Name Case Sensitivity",
"endpointType": "SOURCE",
"checkType": "DB_LOWER_CASE_TABLE_NAMES",
"status": "WARNING",
"message": "The table name case sensitivity check failed. The value of lower_case_table_names is 1 on the source end and 0 on the destination end. Issues may occur during the structure/data migration phase.\n\nDescription of lower_case_table_names:\n0: Table names are stored in the input case, and the case is considered during queries and comparisons.\n1: Table names are always stored in lowercase, but the case is not considered during queries and comparisons.\n2: Table names are stored in the input case, but the case is not considered during queries and comparisons.",
"skippable": true,
"role": "MASTER",
"skipConsequence": null,
"errorDetail": null,
"removable": false,
"blackObjectsInfo": null
},
{
"name": "Source-Master-Precheck of Table Existence",
"endpointType": "SOURCE",
"checkType": "RDB_TABLE_EXIST",
"status": "PASSED",
"message": null,
"skippable": false,
"role": "MASTER",
"skipConsequence": null,
"errorDetail": null,
"removable": false,
"blackObjectsInfo": null
},
{
"name": "Source-Master-Check of Full Read Privileges",
"endpointType": "SOURCE",
"checkType": "DB_ACCOUNT_FULL_READ_PRIVILEGE",
"status": "PASSED",
"message": null,
"skippable": false,
"role": "MASTER",
"skipConsequence": null,
"errorDetail": null,
"removable": false,
"blackObjectsInfo": null
},
{
"name": "Source-Master-Check of Incremental Read Privileges",
"endpointType": "SOURCE",
"checkType": "DB_ACCOUNT_INCR_READ_PRIVILEGE",
"status": "PASSED",
"message": null,
"skippable": false,
"role": "MASTER",
"skipConsequence": null,
"errorDetail": null,
"removable": false,
"blackObjectsInfo": null
},
{
"name": "Source-Master-Check of Primary Key Data Types",
"endpointType": "SOURCE",
"checkType": "DB_DATA_TYPE_INDEX",
"status": "PASSED",
"message": null,
"skippable": true,
"role": "MASTER",
"skipConsequence": null,
"errorDetail": null,
"removable": false,
"blackObjectsInfo": null
},
{
"name": "Source-Master-Check of Database Data Types",
"endpointType": "SOURCE",
"checkType": "DB_DATA_TYPE",
"status": "PASSED",
"message": null,
"skippable": false,
"role": "MASTER",
"skipConsequence": null,
"errorDetail": null,
"removable": false,
"blackObjectsInfo": null
},
{
"name": "Source-Master-Check of Database Engine",
"endpointType": "SOURCE",
"checkType": "DB_ENGINE",
"status": "PASSED",
"message": null,
"skippable": false,
"role": "MASTER",
"skipConsequence": null,
"errorDetail": null,
"removable": false,
"blackObjectsInfo": null
},
{
"name": "Source-Master-Object Foreign Key Dependency Integrity Check",
"endpointType": "SOURCE",
"checkType": "DB_FOREIGN_REFERENCE",
"status": "PASSED",
"message": null,
"skippable": false,
"role": "MASTER",
"skipConsequence": null,
"errorDetail": null,
"removable": false,
"blackObjectsInfo": null
},
{
"name": "Source-Master-Unique Key Check",
"endpointType": "SOURCE",
"checkType": "DB_UK_INDEX",
"status": "PASSED",
"message": null,
"skippable": false,
"role": "MASTER",
"skipConsequence": null,
"errorDetail": null,
"removable": false,
"blackObjectsInfo": null
},
{
"name": "Source-Master-Object Dependency Integrity Check",
"endpointType": "SOURCE",
"checkType": "RDB_OBJECT_DEPENDENCY_INTEGRITY",
"status": "PASSED",
"message": null,
"skippable": true,
"role": "MASTER",
"skipConsequence": null,
"errorDetail": null,
"removable": false,
"blackObjectsInfo": null
},
{
"name": "Destination-Database Connectivity Check",
"endpointType": "DEST",
"checkType": "RDB_CONNECT",
"status": "PASSED",
"message": null,
"skippable": false,
"role": "MASTER",
"skipConsequence": null,
"errorDetail": null,
"removable": false,
"blackObjectsInfo": null
},
{
"name": "Destination-Incremental Log Check",
"endpointType": "DEST",
"checkType": "DB_INCR_LOG",
"status": "PASSED",
"message": null,
"skippable": false,
"role": "MASTER",
"skipConsequence": null,
"errorDetail": null,
"removable": false,
"blackObjectsInfo": null
},
{
"name": "Destination-Maximum Allowed Packet Size Check",
"endpointType": "DEST",
"checkType": "DB_MAX_ALLOWED_PACKET",
"status": "PASSED",
"message": null,
"skippable": true,
"role": "MASTER",
"skipConsequence": null,
"errorDetail": null,
"removable": false,
"blackObjectsInfo": null
},
{
"name": "Destination-Read oceanbase.memstore Privilege Check",
"endpointType": "DEST",
"checkType": "DB_MEMSTORE_READ_PRIVILEGE",
"status": "PASSED",
"message": null,
"skippable": true,
"role": "MASTER",
"skipConsequence": null,
"errorDetail": null,
"removable": false,
"blackObjectsInfo": null
},
{
"name": "Destination-OceanBase Cluster Node Connectivity Check",
"endpointType": "DEST",
"checkType": "DB_NODE_CONNECT",
"status": "PASSED",
"message": null,
"skippable": false,
"role": "MASTER",
"skipConsequence": null,
"errorDetail": null,
"removable": false,
"blackObjectsInfo": null
},
{
"name": "Destination - Database time synchronization check",
"endpointType": "DEST",
"checkType": "DB_TIME_SYNC",
"status": "PASSED",
"message": null,
"skippable": false,
"role": "MASTER",
"skipConsequence": null,
"errorDetail": null,
"removable": false,
"blackObjectsInfo": null
},
{
"name": "Destination - Account write permission check",
"endpointType": "DEST",
"checkType": "DB_ACCOUNT_WRITER_PRIVILEGE",
"status": "PASSED",
"message": null,
"skippable": false,
"role": "MASTER",
"skipConsequence": null,
"errorDetail": null,
"removable": false,
"blackObjectsInfo": null
},
{
"name": "Destination - Schema migration permission check",
"endpointType": "DEST",
"checkType": "DB_STRUCT_PRIVILEGE",
"status": "PASSED",
"message": null,
"skippable": false,
"role": "MASTER",
"skipConsequence": null,
"errorDetail": null,
"removable": false,
"blackObjectsInfo": null
},
{
"name": "Destination - Length limit of the allowlist",
"endpointType": "DEST",
"checkType": "DB_WHITE_LIST_LENGTH",
"status": "PASSED",
"message": null,
"skippable": false,
"role": "MASTER",
"skipConsequence": null,
"errorDetail": null,
"removable": false,
"blackObjectsInfo": null
},
{
"name": "Destination - Log archiving switch check for OceanBase Database 4.x",
"endpointType": "DEST",
"checkType": "OB_ARCHIVE_LOG",
"status": "PASSED",
"message": null,
"skippable": false,
"role": "MASTER",
"skipConsequence": null,
"errorDetail": null,
"removable": false,
"blackObjectsInfo": null
},
{
"name": "Destination - Precheck of read permissions on the OceanBase system view gv$sysstat",
"endpointType": "DEST",
"checkType": "OB_SYS_STAT_VIEW_READ_PRIV",
"status": "PASSED",
"message": null,
"skippable": true,
"role": "MASTER",
"skipConsequence": null,
"errorDetail": null,
"removable": false,
"blackObjectsInfo": null
},
{
"name": "Destination - Full read permission check for account",
"endpointType": "DEST",
"checkType": "DB_ACCOUNT_FULL_READ_PRIVILEGE",
"status": "PASSED",
"message": null,
"skippable": false,
"role": "MASTER",
"skipConsequence": null,
"errorDetail": null,
"removable": false,
"blackObjectsInfo": null
},
{
"name": "Destination - Incremental read permission check for account",
"endpointType": "DEST",
"checkType": "DB_ACCOUNT_INCR_READ_PRIVILEGE",
"status": "PASSED",
"message": null,
"skippable": false,
"role": "MASTER",
"skipConsequence": null,
"errorDetail": null,
"removable": false,
"blackObjectsInfo": null
}
],
"progress": 100.0
}
}