接口请求域名： dts.intl.tencentcloudapi.com 。
配置一个同步任务
默认接口请求频率限制：20次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ConfigureSyncJob。 |
| Version | 是 | String | 公共参数，本接口取值：2021-12-06。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| JobId | 是 | String | 同步实例id（即标识一个同步作业），形如sync-werwfs23，可通过DescribeSyncJobs接口获取。 |
| SrcAccessType | 是 | String | 源端接入类型，cdb(云数据库)、cvm(云服务器自建)、vpc(私有网络)、extranet(外网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、intranet(自研上云),注意具体可选值依赖当前链路 |
| DstAccessType | 是 | String | 目标端接入类型，cdb(云数据库)、cvm(云服务器自建)、vpc(私有网络)、extranet(外网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、intranet(自研上云)、ckafka(CKafka实例),注意具体可选值依赖当前链路 |
| Objects | 是 | Objects | 同步库表对象信息 |
| JobName | 否 | String | 同步任务名称 |
| JobMode | 否 | String | 配置任务模式，默认值为fullMode 枚举值：
|
| RunMode | 否 | String | 运行模式，取值如：Immediate(表示立即运行，默认为此项值)、Timed(表示定时运行) |
| ExpectRunTime | 否 | String | 期待启动时间，当RunMode取值为Timed时，此值必填，形如："2006-01-02 15:04:05" |
| SrcConnectType | 否 | String | 源端tdsql连接方式：proxy-通过tdsql proxy主机访问各个set节点，注意只有在自研上云的网络环境下才能通过这种方式连接，SrcInfos中只需要提供proxy主机信息。set-直连set节点，如选择直连set方式，需要正确填写proxy主机信息及所有set节点信息。源端是tdsqlmysql类型必填。 |
| SrcInfo | 否 | Endpoint | 源端信息，单机版类型数据库配置使用，且SrcNodeType传single。例如mysql、percona、mariadb等。 |
| SrcInfos | 否 | SyncDBEndpointInfos | 源端信息，分布式类型数据库配置使用，且SrcNodeType传cluster。例如分布式数据库tdsqlmysql等，mongodb使用此参数透传。 |
| SrcNodeType | 否 | String | 枚举值：cluster、single。源库为单节点数据库使用single，多节点使用cluster |
| DstInfo | 否 | Endpoint | 目标端信息，单机版类型数据库配置使用，且SrcNodeType传single。例如mysql、percona、mariadb等。 |
| DstInfos | 否 | SyncDBEndpointInfos | 目标端信息，分布式类型数据库配置使用，且SrcNodeType传cluster。例如分布式数据库tdsqlmysql等，mongodb使用此参数透传。 |
| DstNodeType | 否 | String | 枚举值：cluster、single。目标库为单节点数据库使用single，多节点使用cluster |
| Options | 否 | Options | 同步任务选项；该字段下的RateLimitOption暂时无法生效、如果需要修改限速、可通过ModifySyncRateLimit接口完成限速 |
| AutoRetryTimeRangeMinutes | 否 | Integer | 自动重试的时间段、可设置5至720分钟、0表示不重试 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
配置一个同步整库的同步任务
POST / HTTP/1.1
Host: dts.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ConfigureSyncJob
<公共请求参数>
{
"DstInfo": {
"Ip": "9.123.210.46",
"Password": "Test1234",
"User": "root",
"Port": 30654
},
"SrcInfo": {
"Ip": "9.123.211.23",
"Password": "Test1234",
"User": "root",
"Port": "30645"
},
"ExpectRunTime": "0000-00-00 00:00:01",
"DstAccessType": "noProxy",
"JobName": "truexu-api",
"RunMode": "Immediate",
"Objects": {
"Mode": "Partial",
"Databases": [
{
"DbName": "db1",
"DbMode": "All",
"TableMode": "All",
"Tables": null,
"ViewMode": "All",
"Views": null,
"FunctionMode": "All",
"TriggerMode": "",
"EventMode": "",
"ProcedureMode": "All",
"Functions": null,
"Procedures": null,
"Events": null,
"Triggers": null
}
]
},
"JobId": "sync-7r1cz016",
"Options": {
"DealOfExistSameTable": "ExecuteAfterIgnore",
"OpTypes": [
"Update"
],
"DdlOptions": [
{
"DdlObject": "Database",
"DdlValue": [
"Create",
"Alter"
]
}
],
"InitType": "Full",
"ConflictHandleOption": {
"ConditionColumn": "ts",
"ConditionOperator": ">",
"ConditionOrderInSrcAndDst": "<"
}
},
"SrcAccessType": "noProxy"
}{
"Response": {
"RequestId": "8d495a08-5f8f-411b-ae4d-cc6da2475b9c"
}
}配置一个同步包含条件覆盖的任务
POST / HTTP/1.1
Host: dts.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ConfigureSyncJob
<公共请求参数>
{
"DstInfo": {
"Ip": "100.88.178.199",
"Password": "Test1234",
"User": "root",
"Port": 20152
},
"SrcInfo": {
"Ip": "100.88.166.23",
"Password": "Test1234",
"User": "root",
"Port": "20126"
},
"ExpectRunTime": "2021-12-08 11:59:05",
"DstAccessType": "noProxy",
"JobName": "truex",
"RunMode": "Immediate",
"Objects": {
"Mode": "Partial",
"Databases": [
{
"Tables": [
{
"FilterCondition": "id>1",
"TableName": "tb1",
"NewTableName": "tb2"
}
],
"Views": [
{
"ViewName": "vw1",
"NewViewName": "vw2"
}
],
"DbName": "db1",
"ViewMode": "Partial",
"TableMode": "Partial",
"DbMode": "Partial"
}
]
},
"JobId": "sync-31t047r6",
"Options": {
"DdlOptions": [
{
"DdlObject": "Database",
"DdlValue": [
"Drop"
]
}
],
"ConflictHandleType": "ReportError",
"DealOfExistSameTable": "ReportErrorAfterCheck",
"ConflictHandleOption": {
"ConditionColumn": "ts",
"ConditionOperator": ">",
"ConditionOrderInSrcAndDst": ">"
},
"InitType": "Full",
"OpTypes": [
"Insert",
"Update"
],
"AddAdditionalColumn": "false"
},
"SrcAccessType": "noProxy"
}{
"Response": {
"RequestId": "59dd9972-00e7-4ce3-8f33-72d13bc64400"
}
}云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError.InternalHttpServerError | http请求访问出错。 |
| InternalError.UnknownError | 未知的内部错误。 |
| InvalidParameterValue.InvalidParameterValueError | 非法参数。 |
| OperationDenied.OperationDeniedError | 操作被拒绝。 |
| ResourceNotFound.ResourceNotFoundError | 资源未找到。 |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback