DataCheckConfigure parameters - Data Transmission Service

Configure the DataCheckConfigure parameter when you call the ConfigureDtsJob operation to set up data migration or synchronization tasks.

Parameters

DataCheckConfigure is a JSON-formatted string. The following table describes its nested parameters.

Note

You can preview request parameters in the console when configuring an instance. For more information, see Preview OpenAPI request parameters.

Parameter	Type	Description
dataCheckDbList	String	The database objects for data verification. The value must be a string in JSON format.
fullDataCheck	Boolean	Specifies whether to enable full data verification. Valid values are true and false.
fullCheckModel	Integer	The mode for full data verification. Valid values: 1: Verify data by sampling ratio. 2: Verify data row by row.
fullCheckRatio	Integer	The sampling ratio for full data verification, as a percentage. Specify an integer from 10 to 100. Note Required when fullCheckModel is set to 1.
checkMaximumHourEnable	Integer	Specifies whether to set a timeout for the full data verification task. Valid values: 0: Do not set a timeout. 1: Set a timeout. Note This parameter is required when fullCheckModel is set to 1.
checkMaximumHour	Integer	The timeout period, in hours, for the full data verification task. The task terminates if it does not complete within this period. Valid values: 1 to 72.
fullCheckReferEndpoint	String	The benchmark for full data verification. Valid values: all: Uses the union of the source and destination datasets as the benchmark. Verifies all inconsistent data between the source and destination databases. src: Uses the source database as the benchmark. Verifies that all source data exists and matches in the destination. Extra destination data is ignored. dest: Uses the destination database as the benchmark. Verifies that all destination data exists and matches in the source. Extra source data is ignored.
fullCheckMaxReadRps	Integer	The maximum number of rows to read per second. Valid values: 0 to 9007199254740991. Note A value of 0 means no limit.
fullCheckMaxReadBps	Integer	The maximum amount of data to read per second, in bytes. Valid values: 0 to 9007199254740991. Note A value of 0 means no limit.
dataCheckNoticePhone	String	The mobile number of the contact for SMS notifications about data verification alerts.
fullCheckErrorNotice	Boolean	Specifies whether to trigger an alert if the full data verification task fails. Valid values are true and false. Note If set to true, an alert is triggered when the task fails.
fullCheckValidFailNotice	Boolean	Specifies whether to trigger an alert when data inconsistencies are found during full data verification. Valid values are true and false. Note If set to true, an alert is triggered when the number of inconsistent entries reaches or exceeds the specified threshold.
fullCheckNoticeValue	Integer	The alert threshold for inconsistent data from full data verification. Note Required when fullCheckValidFailNotice is set to true.
incrementalDataCheck	Boolean	Specifies whether to enable incremental data verification. Valid values are true and false.
incrementalCheckErrorNotice	Boolean	Specifies whether to trigger an alert if the incremental data verification task fails. Valid values are true and false. Note If set to true, an alert is triggered when the task fails.
incrementalCheckValidFailNotice	Boolean	Specifies whether to trigger an alert when data inconsistencies are found during incremental data verification. Valid values are true and false. Note If set to true, an alert is triggered if the inconsistency count meets or exceeds the threshold for a specified number of consecutive periods.
incrementalCheckValidFailNoticePeriod	Integer	The statistical period for monitoring data inconsistencies. Valid values: 1: 1 minute. 2: 5 minutes. 3: 10 minutes. 4: 30 minutes. Note Required when incrementalCheckValidFailNotice is set to true.
incrementalCheckValidFailNoticeTimes	Integer	The number of consecutive periods the inconsistency count must exceed the threshold before an alert is triggered. Note Required when incrementalCheckValidFailNotice is set to true.
incrementalCheckValidFailNoticeValue	Integer	The alert threshold for the number of inconsistent data entries in each statistical period. Note This parameter is required when incrementalCheckValidFailNotice is set to true.
incrementalCheckDelayNotice	Boolean	Specifies whether to trigger an alert for data latency during incremental data verification. Valid values are true and false. Note If set to true, an alert is triggered if data latency meets or exceeds the threshold for a specified number of consecutive periods.
incrementalCheckDelayNoticePeriod	Integer	The statistical period for monitoring data latency. Valid values: 1: 1 minute. 2: 5 minutes. 3: 10 minutes. 4: 30 minutes. Note Required when incrementalCheckDelayNotice is set to true.
incrementalCheckDelayNoticeTimes	Integer	The number of consecutive periods the data latency must exceed the threshold before an alert is triggered. Note Required when incrementalCheckDelayNotice is set to true.
incrementalCheckDelayNoticeValue	Long	The alert threshold for the incremental data verification task latency, in seconds. Note Required if incrementalCheckDelayNotice is set to true.
structureCheck	Boolean	Specifies whether to enable a structure check. Valid values are true and false.