跳过迁移校验检查项

最近更新时间:2024-03-12 01:28:10

我的收藏

1. 接口描述

接口请求域名: dts.tencentcloudapi.com 。

本接口用于校验检查项不通过后,可进行跳过此校验项操作,后端将不再校验该项。任何校验步骤都是不应该跳过的,通过校验是能正确执行的前置条件。支持跳过的产品及链路的校验项可 参考文档

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:SkipCheckItem。
Version String 公共参数,本接口取值:2021-12-06。
Region String 公共参数,详见产品支持的 地域列表
JobId String 数据迁移任务ID
示例值:dts-1kl0iy0v
StepIds.N Array of String 需要跳过校验项的步骤id,需要通过DescribeMigrationCheckJob接口返回StepInfo[i].StepId字段获取,例如:["OptimizeCheck"]
示例值:["OptimizeCheck"]
ForeignKeyFlag String 当出现外键依赖检查导致校验不通过时、可以通过该字段选择是否迁移外键依赖,当StepIds包含ConstraintCheck且该字段值为shield时表示不迁移外键依赖、当StepIds包含ConstraintCheck且值为migrate时表示迁移外键依赖
示例值:shield

3. 输出参数

参数名称 类型 描述
Message String 跳过的提示信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:skip item successfully
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 跳过迁移校验检查项

当校验不通过时、用户需要跳过校验失败项时、可通过这个接口完成跳过;也可通过这个接口设置是否迁移外键依赖。

输入示例

POST / HTTP/1.1
Host: dts.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SkipCheckItem
<公共请求参数>

{
    "JobId": "dts-1ewjspuw",
    "StepIds": [
        "OptimizeCheck"
    ]
}

输出示例

{
    "Response": {
        "RequestId": "46b45da1-3e8e-4ef2-8de8-b1bffa027385",
        "Message": "skip item successfully"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InvalidParameterValue.InvalidParameterValueError 非法参数。
OperationDenied.OperationDeniedError 操作被拒绝。
ResourceNotFound.ResourceNotFoundError 资源未找到。