接口请求域名： dts.intl.tencentcloudapi.com 。
本接口用于创建数据对比任务，创建成功后会返回数据对比任务 ID，形如：dts-8yv4w2i1-cmp-37skmii9，创建成功后可通过StartCompare启动一致性校验任务
默认接口请求频率限制：20次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateCompareTask。 |
| Version | 是 | String | 公共参数，本接口取值：2021-12-06。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| JobId | 是 | String | 任务 Id，可通过DescribeMigrationJobs接口获取。 |
| TaskName | 否 | String | 数据对比任务名称，若为空则默认给CompareTaskId相同值 |
| ObjectMode | 否 | String | 数据对比对象模式，sameAsMigrate(全部迁移对象， 默认为此项配置)，custom(自定义模式) |
| Objects | 否 | CompareObject | 数据对比对象，当ObjectMode为custom时，此项需要填写。 |
| Options | 否 | CompareOptions | 一致性校验选项 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| CompareTaskId | String | 数据对比任务 ID，形如：dts-8yv4w2i1-cmp-37skmii9 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
POST / HTTP/1.1
Host: dts.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCompareTask
<公共请求参数>
{
"JobId": "dts-p1sposne",
"TaskName": "test_cmp",
"ObjectMode": "custom",
"Objects": {
"ObjectMode": "partial",
"ObjectItems": [
{
"DbName": "big100",
"DbMode": "partial",
"TableMode": "partial",
"Tables": [
{
"TableName": "sbtest1"
}
]
},
{
"DbName": "db1",
"DbMode": "all",
"TableMode": "all",
"ViewMode": "all"
}
]
}
}
{
"Response": {
"CompareTaskId": "dts-8yv4w2i1-cmp-37skmii9",
"RequestId": "ac300ff0-00f2-11ed-b005-4930e69d89c2"
}
}
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure.AuthFailureError | 认证失败。 |
| DryRunOperation.DryRunOperationError | DryRun 操作，代表请求将会是成功的，只是多传了 DryRun 参数。 |
| FailedOperation.FailedOperationError | 操作失败。 |
| InternalError.InternalErrorError | 内部错误。 |
| InternalError.InternalHttpServerError | http请求访问出错。 |
| InvalidParameter.InvalidParameterError | 参数无效。 |
| InvalidParameterValue.InvalidParameterValueError | 非法参数。 |
| LimitExceeded.LimitExceededError | 数量超出限制。 |
| MissingParameter.MissingParameterError | 参数丢失。 |
| OperationDenied.OperationDeniedError | 操作被拒绝。 |
| RequestLimitExceeded.RequestLimitExceededError | 请求次数超限。 |
| ResourceInUse.ResourceInUseError | 资源在使用中。 |
| ResourceInsufficient.ResourceInsufficientError | 资源短缺。 |
| ResourceNotFound.ResourceNotFoundError | 资源未找到。 |
| ResourceUnavailable.ResourceUnavailableError | 资源不可用。 |
| ResourcesSoldOut.ResourcesSoldOutError | 资源售罄。 |
| UnauthorizedOperation.UnauthorizedOperationError | 未授权的操作。 |
| UnknownParameter.UnknownParameterError | 未知参数。 |
| UnsupportedOperation.UnsupportedOperationError | 不支持的操作。 |
文档反馈