修改灾备同步任务

最近更新时间:2018-09-18 17:00:15

1. 接口描述

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

修改灾备同步任务. 当同步任务处于下述状态时, 允许调用本接口: 同步任务创建中, 创建完成, 校验成功, 校验失败. 源实例和目标实例信息不允许修改,可以修改任务名、需要同步的库表。

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi )时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:dts.ap-shanghai-fsi.tencentcloudapi.com 。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifySyncJob
Version String 公共参数,本接口取值:2018-03-30
Region String 公共参数,详见产品支持的地域列表,本接口仅支持其中的: ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-guangzhou-open, ap-hongkong, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, eu-frankfurt, na-siliconvalley, na-toronto
JobId String 待修改的灾备同步任务ID
JobName String 灾备同步任务名称
SyncOption SyncOption 灾备同步任务配置选项
DatabaseInfo String 当选择'指定库表'灾备同步的时候, 需要设置待同步的源数据库表信息,用符合json数组格式的字符串描述, 如下所例。
对于database-table两级结构的数据库:
[{"Database":"db1","Table":["table1","table2"]},{"Database":"db2"}]

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求ID,每次请求都会返回。定位问题时需要提供该次请求的RequestId。

4. 示例

示例1 修改灾备同步任务

输入示例

https://dts.tencentcloudapi.com/?Action==ModifySyncJob
&JobId=sync-blj8wnt1
&JobName=testname3
&DatabaseInfo=[{"Database": "db1"}, {"Database": "db2"}]
&SyncOption.SyncObject=2
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "e3ebe70b-e294-4c15-9377-9e82ef73f342"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、 SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.NotAllowOperation 禁止该操作。
InternalError.DatabaseError 迁移平台数据库访问失败。
InternalError.DuplicateJob 迁移任务冲突。
InternalError.ProtocolError 通信协议错误。
InvalidParameter 参数错误
ResourceNotFound.JobNotExist 迁移任务不存在。