查询数据同步项目的预检查进度和结果

更新时间：2023-06-08 10:49:34

本文为您介绍 OMS 提供的 OpenAPI：查询数据同步项目预检查进度和结果。

功能说明

本接口用于查询数据同步项目的预检查进度和结果。

接口说明

接口约束

本接口适用于 OMS V2.1.2 及以上版本。

请求路径

GET /api/omsp/v2/prechecks/{id}/results

请求参数

Path Parameter

参数	类型	必选	描述
id	string	Y	项目 ID。创建并保存 OceanBase 至 Kafka 同步项目接口会返回该 ID。例如，`sync_2test`。

返回结果

返回结果中显示 projectStatus:FINISHED、progress:100.0 才算成功。

参数	类型	描述
success	boolean	是否调用成功。
code	string	状态码。
message	string	描述信息。
advice	string	建议。
requestId	string	请求 ID。
pageNumber	integer[int32]	当前页数。
pageSize	integer[int32]	每页条数。
totalCount	integer[int64]	总记录数。
cost	string	请求耗时。
data	Object	对于不同的接口，本字段包含的信息不同。

MigrationPreCheckResponse 数据结构

参数	类型	描述
projectId	string	项目 ID。
projectStatus	枚举类型的 string	任务状态。取值包括： * INIT：初始化状态。 * PENDING：暂停状态 * RUNNING：运行中状态。 * FAILED：预检查失败。 * FINISHED：预检查完成。 * SKIPPED：跳过预检查。
preCheckResults	array	任务结果。具体包含的信息，请参见下面的《MigrationPreCheckResult 数据结构》。
progress	number	任务进度。

MigrationPreCheckResult 数据结构

参数	类型	描述
name	string	预检查项目名称。
endpointType	string	终端的类型。取值包括： * SOURCE：源端。 * DEST：目的端。
checkType	string	预检查项目类型。
status	string	预检查项目状态。取值包括 PENDING、RUNNING、FAILED、FINISHED 和 WARNING。
message	string	执行信息。
skippable	boolean	能否跳过预检查。
role	string	主备库信息。取值包括： * MASTER：主库。 * SLAVE：备库。

示例

请求示例

curl --location --request GET 'http://xxx.xxx.xxx.1:8089/api/omsp/v2/prechecks/t_38tt/results' \
--header 'Authorization: Basic YWRt=' \
--header 'Content-Type: application/json' \
--data '{
  "name": "name",
  "sourceEndpointId": "sourceEndpointId",
  "destEndpointId": "destEndpointId",
  "shardColumns": [
    "TENANT_NAME"
  ],
  "kafkaTopic": "test",
  "recordTypes": [
    "INSERT",
    "DELETE",
    "UPDATE"
  ],
  "databaseVOS": [
    {
      "databaseName": "OBSCHEMA",
      "tables": [
        {
          "tableName": "tableName",
          "tableETL": {}
        }
      ]
    }
  ],
  "startTimestamp": 1637568354
}'

返回示例

{
  "success": true,
  "code": "success",
  "message": "abcdefg",
  "advice": "aimikjw",
  "requestId": "a75bcd-7bAc-49Dd-bcFb-abcd",
  "pageNumber": 9699,
  "pageSize": 1553,
  "totalCount": 8651,
  "cost": "abefdcaw",
  "data": {
    "projectId": "7ADbcb-ECba-f4F5-41cA-794",
    "projectStatus": "INIT",
    "preCheckResults": [
      {
        "name": "name",
        "endpointType": "SOURCE",
        "checkType": "DB_TABLE_NAME_UNIQUE",
        "status": "PENDING",
        "message": "abcdefg",
        "skippable": false,
        "role": "MASTER"
      },
      {
        "name": "name",
        "endpointType": "SOURCE",
        "checkType": "DB_TABLE_NAME_UNIQUE",
        "status": "PENDING",
        "message": "abcde",
        "skippable": true,
        "role": "MASTER"
      }
    ],
    "progress": 91.241
  }