1. 接口描述
接口请求域名： dts.tencentcloudapi.com 。
创建一个同步任务
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateSyncJob。 |
| Version | 是 | String | 公共参数，本接口取值：2021-12-06。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| PayMode | 是 | String | 付款类型, 如：PrePay(表示包年包月)、PostPay(表示按时按量) 示例值：PrePay |
| SrcDatabaseType | 是 | String | 源端数据库类型,如mysql,mariadb,percona,postgresql,cynosdbmysql(表示TDSQL-C MySQL),tdpg(TDSQL PostgreSQL版),tdsqlmysql,tdstore(表示TDSQL TDStore版)等。 示例值：mysql |
| SrcRegion | 是 | String | 源端数据库所在地域,如ap-guangzhou 示例值：ap-guangzhou |
| DstDatabaseType | 是 | String | 目标端数据库类型,如mysql,mariadb,percona,cynosdbmysql(表示TDSQL-C MySQL),tdpg(TDSQL PostgreSQL版),tdsqlmysql,kafka,tdstore(表示TDSQL TDStore版)等。 示例值：mysql |
| DstRegion | 是 | String | 目标端数据库所在地域,如ap-guangzhou 示例值：ap-guangzhou |
| Specification | 否 | String | 同步任务规格，Standard:标准版 示例值：Standard |
| Tags.N | 否 | Array of TagItem | 标签信息 |
| Count | 否 | Integer | 一次购买的同步任务数量，取值范围为[1, 10]，默认为1 示例值：1 |
| AutoRenew | 否 | Integer | 自动续费标识，当PayMode值为PrePay则此项配置有意义，取值为：1（表示自动续费）、0（不自动续费，默认为此值） 示例值：1 |
| InstanceClass | 否 | String | 同步链路规格，如micro,small,medium,large，默认为medium 示例值：large |
| JobName | 否 | String | 同步任务名称 示例值：test_job |
| ExistedJobId | 否 | String | 创建类似任务的现有任务Id 示例值：sync-1dd3rjvt |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| JobIds | Array of String | 同步任务ids 示例值：sync-btso140 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建一个同步任务
创建一个同步任务
输入示例
POST / HTTP/1.1
Host: dts.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateSyncJob
<公共请求参数>
{
"Count": 1,
"Specification": "Standard",
"PayMode": "PrePay",
"DstDatabaseType": "mysql",
"DstRegion": "ap-guangzhou",
"SrcDatabaseType": "mysql",
"SrcRegion": "ap-guangzhou",
"ExistedJobId": "sync-xascasas"
}输出示例
{
"Response": {
"JobIds": [
"sync-eivc87yk"
],
"RequestId": "03a378be-372a-478b-beb7-19e4dd5027e2"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure.AuthFailureError | 认证失败。 |
| AuthFailure.UnauthorizedOperationError | 鉴权失败，当前用户不允许执行该操作。 |
| FailedOperation.FailedOperationError | 操作失败。 |
| InternalError.InternalErrorError | 内部错误。 |
| InternalError.InternalInnerCommonError | 内部组件访问错误。 |
| InternalError.InternalTradeError | 调用计费服务失败。 |
| InternalError.NotEnoughMoneyError | 用户余额不足。 |
| InternalError.UnknownError | 未知的内部错误。 |
| InvalidParameterValue.InvalidParameterValueError | 非法参数。 |
| OperationDenied.BizOperationDeniedError | 当前操作不满足条件被阻止。 |
| OperationDenied.NotEnoughMoneyError | 用户余额不足。 |
| OperationDenied.OperationDeniedError | 操作被拒绝。 |
