ShieldPrecheck - Data Transmission Service - Alibaba Cloud Documentation Center

Ignores the precheck items that a data migration or synchronization task may fail to pass.

If you call this operation to ignore all precheck items, you must call the StartMigrationJob or StartSynchronizationJob operation. DTS performs a precheck again. After the data migration or synchronization task passes the precheck, the task will be automatically started.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer automatically generates the sample code of the operation for different SDKs.

Request parameters

Parameter	Type	Required	Example	Description
Action	String	Yes	ShieldPrecheck	The operation that you want to perform. Set the value to ShieldPrecheck.
DtsInstanceId	String	Yes	dtsi76118o3w92****	The ID of the data migration or data synchronization instance. You can call the DescribeMigrationJobs or DescribeSynchronizationJobs operation to query the instance ID.
PrecheckItems	String	Yes	CHECK_SAME_OBJ	The precheck items that you want to ignore. Separate multiple items with commas (,). Valid values: CHECK_SAME_OBJ: schema name conflict CHECK_SAME_USER: multiple usernames for one instance CHECK_SRC: source database version CHECK_TOPOLOGY: topology Note For more information about the topologies supported by DTS, see Synchronization topologies. CHECK_SERVER_ID: value of server_id in the source database
RegionId	String	No	cn-hangzhou	The ID of the region where the data migration or data synchronization instance resides. For more information, see List of supported regions.

Response parameters

Parameter	Type	Example	Description
ErrCode	String	InternalError	The error code returned if the call failed.
ErrMessage	String	The request processing has failed due to some unknown error.	The error message returned if the call failed.
RequestId	String	6F4B5BC4-34B1-49C9-9C8F-C8F16AC4****	The ID of the request.
Success	Boolean	true	Indicates whether the call was successful.

Examples

Sample requests

http(s)://dts.aliyuncs.com/?Action=ShieldPrecheck
&DtsInstanceId=dtsi76118o3w92****
&PrecheckItems=CHECK_SAME_OBJ
&<Common request parameters>

Sample responses

XML format

<ShieldPrecheck>
      <RequestId>6F4B5BC4-34B1-49C9-9C8F-C8F16AC4****</RequestId>
      <Success>true</Success>
</ShieldPrecheck>

JSON format

{
    "RequestId": "6F4B5BC4-34B1-49C9-9C8F-C8F16AC4****",
    "Success": true
}

Error codes

For a list of error codes, visit the API Error Center.