全部产品
Search
文档中心

数据传输服务 DTS:DataCheckConfigure参数说明

更新时间:Dec 02, 2024

在调用ConfigureDtsJob接口配置迁移或同步时,您可以根据需求配置DataCheckConfigure参数。

参数说明

DataCheckConfigure的数据类型为字符串String,传入格式为JSON,详情如下表所示。

说明

您可以在控制台查看使用API接口配置实例时的参数信息,以帮助您正确填写请求参数。更多信息,请参见预览OpenAPI的请求参数

参数

类型

说明

dataCheckDbList

String

数据校验对象,为JSON格式。

fullDataCheck

Boolean

是否进行全量数据校验,取值为truefalse

fullCheckModel

Integer

全量数据校验任务的模式:

  • 1:按抽样比例进行校验。

  • 2:按行进行校验。

fullCheckFixData

Boolean

是否补齐数据,取值为truefalse,默认值为false

说明

当取值为true时,若目标库有跟原库不一致的数据,则会用源库的数据值替换目标库的数据值。

fullCheckRatio

Integer

全量数据校验任务的抽样比例。取值为10~100的整数,单位为%。

说明

fullCheckModel取值为1时必填。

checkMaximumHourEnable

Integer

全量数据校验任务是否配置超时设置:

  • 0:不配置超时设置。

  • 1:配置超时设置。

说明

fullCheckModel取值为1时必填。

checkMaximumHour

Integer

全量数据校验任务的超时设置,取值为1~72的整数。在全量数据校验任务启动后开始计时,若校验任务未在指定时间完成则强制结束。

fullCheckReferEndpoint

String

全量数据校验的基准,取值为:

  • all:以源库和目标库数据的合集为基准,校验源库和目标库不一致的数据。

  • src:以源库为基准,校验目标库与源库数据的一致性(不校验目标库比源库多的数据)。

  • dest:以目标库为基准,校验源库与目标库数据的一致性(不校验源库比目标库多的数据)。

fullCheckMaxReadRps

Integer

每秒读取数据的最大行数,取值为0~9007199254740991的整数。

说明

取值为0时表示不做限制。

fullCheckMaxReadBps

Integer

每秒读取的最大数据量(Byte),取值为0~9007199254740991的整数。

说明

取值为0时表示不做限制。

dataCheckNoticePhone

String

全量或增量数据校验任务告警联系人的手机号。当校验任务触发告警时,将以短信的形式通知告警联系人。

fullCheckErrorNotice

Boolean

是否进行全量数据校验失败告警。取值为truefalse

说明

当取值为true时,全量数据校验任务失败则触发告警。

fullCheckValidFailNotice

Boolean

是否进行全量校验数据不一致告警。取值为truefalse

说明

当取值为true时,全量校验任务不一致数据的数量大于等于设置的阈值则触发告警。

fullCheckNoticeValue

Integer

全量数据校验不一致数据的告警阈值。

说明

fullCheckValidFailNotice取值为true时必填。

incrementalDataCheck

Boolean

是否进行增量数据校验,取值为truefalse

incrementalCheckErrorNotice

Boolean

是否进行增量数据校验失败告警。取值为truefalse

说明

当取值为true时,增量数据校验任务失败则触发告警。

incrementalCheckValidFailNotice

Boolean

是否进行增量校验数据不一致告警。取值为truefalse

说明

当取值为true时,若增量校验任务累计在若干个周期的不一致记录量均大于等于设置的阈值则触发告警。

incrementalCheckValidFailNoticePeriod

Integer

增量数据校验任务不一致告警统计的周期:

  • 1:表示周期为1分钟。

  • 2:表示周期为5分钟。

  • 3:表示周期为10分钟。

  • 4:表示周期为30分钟。

说明

incrementalCheckValidFailNotice取值为true时必填。

incrementalCheckValidFailNoticeTimes

Integer

增量数据校验任务不一致告警统计周期的数量。

说明

incrementalCheckValidFailNotice取值为true时必填。

incrementalCheckValidFailNoticeValue

Integer

增量数据校验任务不一致数据的告警阈值。

说明

incrementalCheckValidFailNotice取值为true时必填。

incrementalCheckDelayNotice

Boolean

是否进行增量数据延迟告警。取值为truefalse

说明

当取值为true时,若增量校验任务累计在若干个周期的延迟均大于等于设置的阈值则触发告警。

incrementalCheckDelayNoticePeriod

Integer

增量数据校验任务延迟告警的统计周期:

  • 1:表示周期为1分钟。

  • 2:表示周期为5分钟。

  • 3:表示周期为10分钟。

  • 4:表示周期为30分钟。

说明

incrementalCheckDelayNotice取值为true时必填。

incrementalCheckDelayNoticeTimes

Integer

增量数据校验任务延迟告警统计周期的数量。

说明

incrementalCheckDelayNotice取值为true时必填。

incrementalCheckDelayNoticeValue

Long

增量数据校验任务延迟时间的告警阈值,单位为秒。

说明

incrementalCheckDelayNotice取值为true时必填。

structureCheck

Boolean

是否进行结构校验,取值为truefalse