Updating the Start Point of an Incremental Task

Function

This API is used to update the start point of an incremental task.

Constraints

This API is only available for incremental synchronization from MySQL to MySQL, MySQL to GaussDB(DWS), MySQL to TaurusDB, MySQL to Oracle, MySQL to Kafka, TaurusDB to TaurusDB, TaurusDB to MySQL, TaurusDB to Oracle, TaurusDB to Kafka, MongoDB to Kafka, and MongoDB to DDS.
This API can be used only in certain regions. For details, see Endpoints.

URI

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

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID of a tenant in a region. For details, see Obtaining a Project ID.
job_id	Yes	String	Task ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	MIME type of the request body. Use the default value application/json. For APIs used to upload objects or images, the value varies depending on the flow type. The default value is application/json.
X-Auth-Token	Yes	String	User token obtained from IAM. It is a response to the API for obtaining a user token. After a request is processed, the value of X-Subject-Token in the header is the token value.
X-Language	No	String	Request language type. Default value: en-us Enumerated values: en-us zh-cn

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
file_and_position	Yes	String	When MySQL serves as the source database, run show master status to obtain the start point of the source database and set File and Position as prompted. For example, mysql-bin.000277:805, in which the file name can contain only 1 to 60 characters and cannot contain the following special character <>&:"'/\\, the file number can contain only 3 to 20 digits, the binlog event position can contain only 1 to 20 digits, and the total length cannot exceed 100 characters. The value is in the format of File_name.file_number:Event_position. When MongoDB serves as the source database, the source database logs are obtained from within the time range of the oplog, starting with the current start position. To check whether the start position is within the oplog time range, run db.getReplicationInfo() for a non-cluster instance, and for a cluster instance, run db.watch([], {startAtOperationTime: Timestamp(xx, xx)}), where xx is the start position you specified. The value is in the format of timestamp:incre. The values of timestamp and incre are integers ranging from 1 to 2,147,483,647.
gtid_set	No	String	This parameter is mandatory for tasks whose source database is MySQL. Run show master status to obtain the start point of the source database and set Executed_Gtid_Set as prompted. (If the source database is MySQL 5.5, synchronization tasks are not supported.) Enter a maximum of 2048 characters. Chinese characters and the following special characters are not allowed: < > & " ' / \\

Response Parameters

None

Example Request

Updating start point for a synchronization task from MySQL to MySQL

https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs/c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r/start-position

{
  "file_and_position" : "mysql-bin.000277:805",
  "gtid_set" : "123"
}

Updating start point for a synchronization task from MongoDB to Kafka

https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs/c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r/start-position

{
  "file_and_position" : "123:12345"
}