You need to enable JavaScript to run this app.
导航
CreateValidationTask
最近更新时间:2024.12.31 11:00:39首次发布时间:2024.12.31 11:00:39

调用 CreateValidationTask 接口创建数据校验任务。

请求类型

同步请求。

注意事项

  • 数据校验任务执行时,只能有一个校验任务在运行,多个校验任务可能会造成源端和目标端数据库的负载。

  • 在迁移或同步过程中,请勿进行以下操作,否则可能会导致校验结果不一致:

    • 对源端数据库做 DDL 操作。

    • 请勿对目标数据库进行写入操作。

  • 当任务完成全量迁移或全量初始化时校验任务才开始校验数据。

  • DTS 不会校验既没有主键约束也没有唯一约束的数据。

  • 如果同步或迁移任务进行重启操作(例如启动暂停后的任务),则任务中的数据校验任务会自动终止,且任务状态变更为已完成,如果需要对数据进行数据校验,您需要重新创建数据校验任务。

  • 在执行校验任务前需评估源端和目标端的数据库性能,建议您在业务低峰期执行数据校验(例如源库和目标库的 CPU 负载在 30% 以下)。因为 DTS 在进行数据校验时将占用源库和目标库一定的读资源,可能会导致数据库负载上升。在数据库性能较差、规格较低或业务量较大的情况下,可能会加重数据库的压力,甚至导致数据库服务不可用。

  • 数据校验的收费信息,请参见数据校验计费信息

请求参数

参数类型是否必选示例值描述

TaskName

String

test

数据校验任务名称,命名规则如下:

  • 以字母开头,长度需在 64 个字符内,且不可为空。

  • 只可以包含字母、数字、下划线(_)和中划线(-)。

TaskType

String

DataMigration

任务类型。取值为 DataValidation,表示数据校验任务。

ParentTaskIDStringf73ce100b7534a2ea34dcea6ad******迁移或同步任务 ID。

ChargeConfig

Object

{
     "PostPaid"
}

计费配置。详细信息,请参见 ChargeConfig

SolutionSettings

Object

{
    "SolutionType": "MySQL2MySQLRowCompare",
    "MySQL2MySQLRowCompareSettings": {
         "SampleRate": 100,
         "ObjectMappings": [
              {
                 "ObjectType": "Database",
                 "SrcObjName": "dts_acsii",
                 "DestObjName": "dts_acsii",
                 "MappingList": [
                     {
                         "ObjectType": "Table",
                         "SrcObjName": "*",
                         "DestObjName": "*"
                      }
                  ]
              }
          ]
      }
}

数据校验任务对象的配置信息。详细信息,请参见 SolutionSetting

返回参数

参数类型示例值描述
TaskIdStringfdea8d75b3c343b0940a67bd******数据校验任务 ID。

请求示例

POST /?Action=CreateValidationTask&Version=2022-10-01 HTTP/1.1
Content-Type: application/json
Host:dts.volcengineapi.com
X-Date: 20221001T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20221001/cn-beijing/dts/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c645****

{
    "TaskName": "d123",
    "ChargeConfig": {
        "ChargeType": "PostPaid",
        "Times": 1
    },
    "SolutionSettings": {
        "SolutionType": "MySQL2MySQLRowCompare",
        "MySQL2MySQLRowCompareSettings": {
            "SampleRate": 100,
            "ObjectMappings": [
                {
                    "ObjectType": "Database",
                    "SrcObjName": "dts_acsii",
                    "DestObjName": "dts_acsii",
                    "MappingList": [
                        {
                            "ObjectType": "Table",
                            "SrcObjName": "*",
                            "DestObjName": "*"
                        }
                    ]
                }
            ]
        }
    },
    "TaskType": "DataValidation",
    "ParentTaskID": "f73ce100b7534a2ea34dcea6a******",
    "IdempotencyKey": "8af3813f-4e17-49e2-b08a-64b83e******"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20241212104712CD2A8CF57FB0F2986785-f09a45",
        "Action": "DescribeValidationTaskResult",
        "Version": "2022-10-01",
        "Service": "dts",
        "Region": "cn-beijing"
    },
    "Result": {
        "TaskId": "fdea8d75b3c343b0940a67bd******"
}

错误码

更多详情,请参见错误码