CreateDataValidationTask--数据库传输服务-火山引擎

文档中心

立即注册

导航

CreateDataValidationTask

最近更新时间：2024.09.24 16:39:49首次发布时间：2023.03.29 20:42:36

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

请求类型

同步请求。

注意事项

数据校验任务执行时，只能有一个校验任务在运行，多个校验任务可能会造成源端和目标端数据库的负载。
在迁移或同步过程中，请勿进行以下操作，否则可能会导致校验结果不一致：
- 对源端数据库做 DDL 操作。
- 请勿对目标数据库进行写入操作。
当任务完成全量迁移或全量初始化时校验任务才开始校验数据。
DTS 不会校验既没有主键约束也没有唯一约束的数据。
如果同步或迁移任务进行重启操作（例如启动暂停后的任务），则任务中的数据校验任务会自动终止，且任务状态变更为已完成，如果需要对数据进行数据校验，您需要重新创建数据校验任务。
在执行校验任务前需评估源端和目标端的数据库性能，建议您在业务低峰期执行数据校验（例如源库和目标库的 CPU 负载在 30% 以下）。因为 DTS 在进行数据校验时将占用源库和目标库一定的读资源，可能会导致数据库负载上升。在数据库性能较差、规格较低或业务量较大的情况下，可能会加重数据库的压力，甚至导致数据库服务不可用。
数据校验暂时免费。

请求参数

参数	类型	是否必选	示例值	描述
TaskId	String	是	412d310abd124577a8b3c6fb288*****	任务 ID。说明您可以调用 DescribeTransmissionTasks 接口查询任务 ID。
ValidationType	String	是	DataValidationTypeMetaCompare	数据校验方式。取值如下： `DataValidationTypeFullRowCompare`：表示全量内容校验。支持创建 MySQL、veDB MySQL、PostgreSQL、MongoDB 类型的全量内容校验。 `DataValidationTypeFullRowCountCompare`：表示全量行数校验。支持创建 MySQL、veDB MySQL、MongoDB 类型的全量内容校验。 `DataValidationTypeFullPkRowCompare`：表示主键校验，仅 MongoDB 类型的任务支持配置该参数取值。 `DataValidationTypeMetaCompare`：表示结构校验。支持创建 MySQL、veDB MySQL 类型的全量内容校验。
TaskName	String	否	ddd	任务名称。命名规则：以字母开头，且不能为空。长度需在 64 个字符内。只能包含字母、数字、下划线（_）和中划线（-）。

返回参数

参数	类型	示例值	描述
ValidationTaskID	String	db0e21b0e17c4c768527cd3d5b*****	校验任务 ID。

示例

请求示例

POST /?Action=CreateDataValidationTask&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****
{
    "TaskId": "b30dc8486811423f9cebc589f6*****",
    "TaskName": "test****"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2023032013592945E7C5881E11090F0B46",
        "Action": "CreateDataValidationTask",
        "Version": "2022-10-01",
        "Service": "dts",
        "Region": "cn-beijing"
    },
    "Result": {
        "ValidationTaskID": "db0e21b0e17c4c768527cd3d5b*****"
    }
}

错误码

更多详情，请参见错误码。