Data Transfer Service
- Release Notes and Announcements
- Announcements
- Product Introduction
- Specification Description
- Preparations
- Network Preparation
- Interworking Between local IDC and Tencent Cloud
- Adding DTS IP Addresses to the Allowlist of the Corresponding Databases
- DTS Service Permission Preparation
- Data Migration
- Migration to MySQL Series
- Migrating to MySQL
- Migrating to MariaDB
- Migrating to TDSQL-C for MySQL
- Migrating to TDSQL MySQL
- Migrating to TDSQL TDStore
- Advanced Operations for MySQL Series Migration
- Processing for MySQL Series Pre-Check Failure
- Migrating to PostgreSQL
- Processing for PostgreSQL Series Pre-Check Failure
- Migrating to MongoDB
- Migration from MongoDB to MongoDB
- Fix for Verification Failure
- MongoDB Data Consistency Verification
- Migrating to SQL Server
- Migration from SQL Server to TencentDB for SQL Server
- Pre-Validation Failure Handling
- Migrating to TencentDB for Redis
- Migration from Redis to Redis
- Fix for Verification Failure
- Migrating to KeeWiDB
- Migration from Redis to KeeWiDB
- Task Management
- Data Sync
- Sync to MySQL series
- Sync to MySQL
- Sync to MariaDB
- Sync to TDSQL-C for MySQL
- Sync to TDSQL for MySQL
- Sync from TDSQL for MySQL to TDSQL for MySQL
- Sync to TDSQL TDStore
- MySQL Series Advanced Sync Operations
- MySQL series Pre Validation Failed Processing
- Synchronize to PostgreSQL
- PostgreSQL Pre Validation does not Pass Processing
- Synchronize to Kafka
- MySQL/MariaDB/Percona/TDSQL-C MySQL Sync to Kafka
- TDSQL MySQL Sync to Kafka
- Task Management
- Data Subscription (Kafka Edition)
- MySQL series Data Subscription
- Consuming MySQL Data
- Advanced Subscription Operations
- Fix for Verification Failure
- Data Subscription for TDSQL PostgreSQL
- Fix for Verification Failure
- MongoDB Data Subscription
- Fix for Verification Failure
- Task Management
- Consumption Management
- Fix for Verification Failure
- Monitoring and Alarms
- Configuring Metric Alarms and Event Alarms via the Console
- Practical Tutorial
- FAQs
- Error Handling
- API Documentation
- Making API Requests
- (NewDTS) Data Migration APIs
- Data Sync APIs
- Data Consistency Check APIs
- (NewDTS) Data Subscription APIs
- DTS API 2018-03-30
- Data Subscription APIs
- Making API Requests
- DTS APIs
- Service Agreement
SkipCheckItem
Last updated: 2024-12-04 15:34:52
1. API Description
Domain name for API request: dts.intl.tencentcloudapi.com.
This API is used for the backend to skip a failed check item. Theoretically, to execute a migration task normally, any check step cannot be skipped, and the check must be passed. For products or links that support check item skipping, see Check Item Overview.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: SkipCheckItem. |
| Version | Yes | String | Common Params. The value used for this API: 2021-12-06. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| JobId | Yes | String | Data migration task ID |
| StepIds.N | Yes | Array of String | ID of the check step to be skipped, which is obtained in the StepInfo[i].StepId field returned by the DescribeMigrationCheckJob API, such as "OptimizeCheck". |
| ForeignKeyFlag | No | String | When the check fails due to foreign key dependency, you can use this field to specify whether to migrate the foreign key dependency. The foreign key dependency won’t be migrated when StepIds contains ConstraintCheck and the value of this field is shield, and will be migrated when StepIds contains ConstraintCheck and the value of this field is migrate. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| Message | String | Message prompted for skipping the check item Note: This field may return null, indicating that no valid values can be obtained. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
4. Example
Example1 Skipping a migration check item
This example shows you how to call this API to skip a failed check item when the check fails or to specify whether to migrate the foreign key dependency.
Input Example
POST / HTTP/1.1
Host: dts.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SkipCheckItem
<Common request parameters>
{
"JobId": "dts-1ewjspuw",
"StepIds": [
"OptimizeCheck"
]
}
Output Example
{
"Response": {
"RequestId": "46b45da1-3e8e-4ef2-8de8-b1bffa027385",
"Message": "skip item successfully"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
6. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InvalidParameterValue.InvalidParameterValueError | The parameter is invalid. |
| OperationDenied.OperationDeniedError | The operation was denied. |
| ResourceNotFound.ResourceNotFoundError | The resource was not found. |
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No