Home PageData Transmission ServiceDeveloper ReferenceAPI ReferenceDTS API (new and recommended)SkipPreCheck
Search for Help Content

SkipPreCheck

Updated at: 2024-09-06 10:29
Community

Skips or stops skipping one or more precheck items.

Debugging

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

调试

Request parameters

Parameter

Type

Required

Example

Description

Parameter

Type

Required

Example

Description
Action String Yes SkipPreCheck

The operation that you want to perform. Set the value to SkipPreCheck.

JobId String Yes b4my3zg929a****

The precheck task ID. You can call the DescribePreCheckStatus operation to query the task ID.

Skip Boolean Yes true

Specifies whether to skip the precheck item. Valid values:

  • true
  • false
SkipPreCheckItems String Yes ["CHECK_SAME_OBJ"]

The shortened name of the precheck item. Valid values:

  • ["CHECK_SAME_OBJ"]: object name conflict.
  • ["CHECK_SAME_USER"]: username conflict.
  • ["CHECK_SRC"]: source database version.
  • ["CHECK_TOPOLOGY"]: topology. For more information about the topologies supported by Data Transmission Service (DTS), see Synchronization topologies.
  • ["CHECK_SERVER_ID"]: the server ID of the source database.
  • ["CHECK_DEST_TABLE_EMPTY"]: existence of objects in the destination database.
Note
Separate multiple item names with commas (,). Example: ["CHECK_SRC","CHECK_SAME_OBJ"].
SkipPreCheckNames String Yes ["CHECK_SAME_OBJ_DETAIL"]

The precheck item name. This parameter corresponds to SkipPreCheckItems. Valid values:

  • ["CHECK_SAME_OBJ_DETAIL"]: object name conflict.
  • ["CHECK_SAME_USER_DETAIL"]: username conflict.
  • ["CHECK_SRC_DETAIL"]: source database version.
  • ["CHECK_TOPOLOGY_DETAIL"]: topology. For more information about the topologies supported by DTS, see Synchronization topologies.
  • ["CHECK_SERVER_ID_DETAIL"]: the server ID of the source database.
  • ["CHECK_DEST_TABLE_EMPTY_DETAIL"]: empty tables in the destination database.
Note
Separate multiple item names with commas (,). Example: ["CHECK_SRC_DETAIL","CHECK_SAME_OBJ_DETAIL"].
DtsJobId String Yes c7412z57g8k****

The ID of the data migration, data synchronization, or change tracking task.

RegionId String No cn-hangzhou

The region ID of the DTS instance. For more information, see Supported regions.

ResourceGroupId String No rg-acfmzawhxxc****

The resource group ID.

Response parameters

Parameter

Type

Example

Description

Parameter

Type

Example

Description
HttpStatusCode Integer 200

The HTTP status codes returned.

RequestId String 8C498360-7892-433C-847A-BA71A850****

The request ID.

ErrCode String InternalError

The error code returned if the call failed.

Success Boolean true

Indicates whether the request is successful.

ErrMessage String The Value of Input Parameter %s is not valid.

The error message returned if the request failed.

SkipNames String CHECK_SAME_OBJ_DETAIL

The precheck item name.

Code String 200

The error code. This parameter will be removed in the future.

ScheduleJobId String b4my3zg929a****

The precheck task ID.

DynamicMessage String JobId

The dynamic part in the error message. This parameter is used to replace %s in ErrMessage.

Note
If JobId is invalid, JobId is returned for DynamicMessage, and the following message is returned for ErrMessage: The Value of Input Parameter %s is not valid.
MigrationJobId String b4my3zg929a****

The precheck task ID.

SkipItems String CHECK_SAME_OBJ

The shortened name of the precheck item.

Examples

Sample requests

http(s)://dts.aliyuncs.com/?Action=SkipPreCheck
&JobId= b4my3zg929a****
&SkipPreCheckItems=["CHECK_SAME_OBJ","CHECK_SRC"]
&SkipPreCheckNames=["CHECK_SAME_OBJ_DETAIL","CHECK_SRC_DETAIL"]
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<SkipPreCheckResponse>
    <HttpStatusCode>200</HttpStatusCode>
    <RequestId>8C498360-7892-433C-847A-BA71A850****</RequestId>
    <Success>true</Success>
    <SkipNames>CHECK_SAME_OBJ_DETAIL</SkipNames>
    <ScheduleJobId>b4my3zg929a****</ScheduleJobId>
    <MigrationJobId>b4my3zg929a****</MigrationJobId>
    <SkipItems>CHECK_SAME_OBJ</SkipItems>
</SkipPreCheckResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "HttpStatusCode" : 200,
  "RequestId" : "8C498360-7892-433C-847A-BA71A850****",
  "Success" : true,
  "SkipNames" : "CHECK_SAME_OBJ_DETAIL",
  "ScheduleJobId" : "b4my3zg929a****",
  "MigrationJobId" : "b4my3zg929a****",
  "SkipItems" : "CHECK_SAME_OBJ"
}

Error codes

HttpCode

Error code

Error message

Description

HttpCode

Error code

Error message

Description
400 Throttling.User Request was denied due to user flow control. The number of calls per second exceeds the limit. Try again later.
500 ServiceUnavailable The request has failed due to a temporary failure of the server. The response of the server timed out or the server was unavailable. Try again. If the error persists, contact technical support.
403 InvalidSecurityToken.Expired Specified SecurityToken is expired. The signature expired. Use a new signature.

For a list of error codes, see Service error codes.

Previous: DeleteConsumerChannelNext: Describe DTS Job
  • On this page （1, O）
  • Debugging
  • Request parameters
  • Response parameters
  • Examples
  • Error codes
Feedback