Updating Task Parameters

Function

This API is used to update task parameters.

Constraints

This API is available only for real-time synchronization tasks from MySQL to MySQL, MySQL to PostgreSQL, MySQL to GaussDB Distributed, MySQL to GaussDB Primary/Standby, MySQL to GaussDB(DWS), MySQL to GaussDB(for MySQL), MySQL to Kafka, MySQL to CSS/ES, and MySQL to Oracle.
This API is used for real-time synchronization tasks in the Configuration, Full, Incremental, Full failed, Incremental failed, or Paused state.

URI

PUT /v5/{project_id}/jobs/{job_id}/modify-configuration

**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
values	Yes	Array of objects	Parameter values initialized based on the default parameter template. For details, see Table 4.

**Table 4** Data structure description of field **values**
Parameter	Mandatory	Type	Description
parameter_name	Yes	String	Parameter name, for example, applier_thread_num and read_task_num. If this parameter is not specified, no parameter value is to be changed.
parameter_value	Yes	String	Value of a parameter, for example, 20 or false. If parameter_name is not empty, parameter_value cannot be empty, either.

Response Parameters

None

Example Request

Updating the number of threads for writing data to the destination database during the full migration phase and number of threads for reading data from the source database during the full migration phase

https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs/c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r/modify-configuration 
 
{ 
  "values" : [ { 
    "parameter_name" : "applier_thread_num", 
    "parameter_value" : "20" 
  }, { 
    "parameter_name" : "read_task_num", 
    "parameter_value" : "3" 
  } ] 
}