When you call the ConfigureDtsJob operation to configure a data migration or data synchronization task, you can set the DataCheckConfigure parameter based on your requirements.

Parameters

The data type of the DataCheckConfigure parameter is String, and the value must be specified in the JSON format. The following table describes the parameters nested within the DataCheckConfigure parameter.

ParameterTypeDescription
dataCheckDbListStringThe objects whose data is to be verified. The value must be a JSON string.
fullDataCheckBooleanSpecifies whether to perform a full data verification task. Valid values: true and false.
fullCheckModelIntegerThe mode of the full data verification task. Valid values:
  • 1: verifies the data by sampling ratio.
  • 2: verifies the data by row.
fullCheckFixDataBooleanSpecifies whether to replace the inconsistent data. Valid values: true and false. Default value: false.
Note For example, you set this parameter to true. If the destination database has data that is inconsistent with the data in the source database, the data values of the destination database are replaced with those of the source database.
fullCheckRatioIntegerThe sampling ratio of the full data verification task. Valid values: integers from 10 to 100. Unit: percent.
Note This parameter is required if the fullCheckModel parameter is set to 1.
checkMaximumHourEnableIntegerSpecifies whether to configure a timeout period for the full data verification task.
  • 0: does not configure a timeout period for the full data verification task.
  • 1: configures a timeout period for the full data verification task.
Note This parameter is required if the fullCheckModel parameter is set to 1.
checkMaximumHourIntegerThe timeout period of the full data verification task. Valid values: integers from 1 to 72. Countdown begins the moment the full data verification task is started. If the task is not complete within the specified timeout period, the task is forcibly stopped.
fullCheckReferEndpointStringThe benchmark for full data verification. Valid values:
  • all: checks the data consistency between the source and destination databases based on the source and destination databases.
  • src: checks the data consistency between the source and destination databases based on the source database. Objects that exist in the destination database but do not exist in the source database are not checked.
  • dest: checks the data consistency between the source and destination databases based on the destination database. Objects that exist in the source database but do not exist in the destination database are not checked.
fullCheckMaxReadRpsIntegerThe maximum number of data rows that are read per second. Valid values: integers from 0 to 9007199254740991.
fullCheckMaxReadBpsIntegerThe maximum number of bytes that are read per second. Valid values: integers from 0 to 9007199254740991.
dataCheckNoticePhoneStringThe mobile number of the alert contact for a full or incremental data verification task. If an alert is triggered for a verification task, a text message is sent to notify the alert contact.
fullCheckErrorNoticeBooleanSpecifies whether to trigger an alert if the full data verification task fails. Valid values: true and false.
Note For example, you set this parameter to true. If the full data verification task fails, an alert is triggered.
fullCheckValidFailNoticeBooleanSpecifies whether to trigger an alert if inconsistent data is detected by the full data verification task. Valid values: true and false.
Note For example, you set this parameter to true. If the number of inconsistent data entries detected by the full data verification task is greater than or equal to the threshold that you specified, an alert is triggered.
fullCheckNoticeValueIntegerThe alert threshold for inconsistent data entries detected by the full data verification task.
Note This parameter is required if the fullCheckValidFailNotice parameter is set to true.
incrementalDataCheckBooleanSpecifies whether to perform an incremental data verification task. Valid values: true and false.
incrementalCheckErrorNoticeBooleanSpecifies whether to trigger an alert if the incremental data verification task fails. Valid values: true and false.
Note For example, you set this parameter to true. If the incremental data verification task fails, an alert is triggered.
incrementalCheckValidFailNoticeBooleanSpecifies whether to trigger an alert if inconsistent data is detected by the incremental data verification task. Valid values: true and false.
Note For example, you set this parameter to true. If the cumulative number of inconsistent data entries detected by the incremental data verification task in several statistical periods is greater than or equal to the threshold that you specified, an alert is triggered.
incrementalCheckValidFailNoticePeriodIntegerThe statistical period of an alert on inconsistent data entries detected by the incremental data verification task. Valid values:
  • 1: 1 minute
  • 2: 5 minutes
  • 3: 10 minutes
  • 4: 30 minutes
Note This parameter is required if the incrementalCheckValidFailNotice parameter is set to true.
incrementalCheckValidFailNoticeTimesIntegerThe number of statistical periods of an alert on inconsistent data entries detected by the incremental data verification task.
Note This parameter is required if the incrementalCheckValidFailNotice parameter is set to true.
incrementalCheckValidFailNoticeValueIntegerThe alert threshold for inconsistent data entries detected by the incremental data verification task.
Note This parameter is required if the incrementalCheckValidFailNotice parameter is set to true.
incrementalCheckDelayNoticeBooleanSpecifies whether to trigger an alert on the data latency of the incremental data verification task. Valid values: true and false.
Note For example, you set this parameter to true. If the cumulative latency of the incremental data verification task in several statistical periods is greater than or equal to the threshold that you specified, an alert is triggered.
incrementalCheckDelayNoticePeriodIntegerThe statistical period of an alert on the data latency of the incremental data verification task. Valid values:
  • 1: 1 minute
  • 2: 5 minutes
  • 3: 10 minutes
  • 4: 30 minutes
Note This parameter is required if the incrementalCheckDelayNotice parameter is set to true.
incrementalCheckDelayNoticeTimesIntegerThe number of statistical periods of an alert on the data latency of the incremental data verification task.
Note This parameter is required if the incrementalCheckDelayNotice parameter is set to true.
incrementalCheckDelayNoticeValueLongThe alert threshold for the data latency of the incremental data verification task. Unit: seconds.
Note This parameter is required if the incrementalCheckDelayNotice parameter is set to true.