文档首页/ 数据复制服务 DRS/ API参考/ API v5（公测中）/ 实例操作/ 更新增量任务启动位点
更新时间：2024-03-14 GMT+08:00
在线调试
CLI示例
查看PDF
分享

更新增量任务启动位点

功能介绍

更新增量任务的启动位点。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

接口约束

  • 目前仅支持MySQL->MySQL、MySQL->GaussDB(DWS)、MySQL->GaussDB(for MySQL)、MySQL->Oracle、MySQL->Kafka、GaussDB(for MySQL)->GaussDB(for MySQL)、GaussDB(for MySQL)->MySQL、GaussDB(for MySQL)->Oracle、GaussDB(for MySQL)->Kafka、MongoDB->Kafka、MongoDB->DDS且为单增量的同步场景。
  • 仅支持部分Region使用，详情参考终端节点。

URI

PUT /v5/{project_id}/jobs/{job_id}/start-position

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一Region下的Project ID。

获取方法请参见获取项目ID。

job_id

是

String

任务ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

发送的实体的MIME类型。推荐用户默认使用application/json，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。

缺省值：application/json

X-Auth-Token

是

String

从IAM服务获取的用户Token。用户Token也就是调用IAM获取用户Token接口的响应值，请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

X-Language

否

String

请求语言类型。

缺省值：en-us

枚举值：

  • en-us
  • zh-cn
表3 请求Body参数

参数

是否必选

参数类型

描述

file_and_position

是

String
  • MySQL为源通过show master status命令获取源库位点，根据提示分别填写File:Position。例如：mysql-bin.000277:805 文件名只能为1-60个字符且不能包含< > & : " ' / \\ 特殊字符，文件编号只能为3-20个数字，binlog事件位置只能为1-20个数字，且总长度不能超过100个字符。格式为：文件名.文件编号:事件位点。
  • MongoDB为源的任务，任务的源库日志从位点开始获取（含当前启动位点），位点需设置在oplog范围以内。非集群通过db.getReplicationInfo()直接获得oplog范围，集群通过db.watch([], {startAtOperationTime: Timestamp(xx, xx)})命令，将启动位点填在xx处，校验位点是否在oplog范围以内。格式为：timestamp:incre。timestamp和incre均为范围在1~2,147,483,647之间的整数。

gtid_set

否

String
  • MySQL为源的任务需要填写。通过show master status命令获取源库位点，根据提示填写Executed_Gtid_Set（如果源库为MySQL 5.5版本，则不支持使用同步任务）。
  • 不能包含< > & " ' / \\ 特殊字符和中文。且不能超过2048个字符。

响应参数

无

请求示例

  • MySQL->MySQL更新启动位点： 
    https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs/c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r/start-position

{
  "file_and_position" : "mysql-bin.000277:805",
  "gtid_set" : "123"
}
  • MongoDB->Kafka更新启动位点： 
    https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs/c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r/start-position

{
  "file_and_position" : "123:12345"
}

响应示例

状态码： 200

OK

{}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： 实例操作

相关文档