Help Center/Data Replication Service/API Reference/APIs V3.0 (Deprecated)/Real-Time Synchronization Management/Advanced Settings
Updated on 2025-11-19 GMT+08:00
View PDF

Advanced Settings

Function

This API is used to change the values of tuning parameters.

URI

PUT /v3/{project_id}/job/{job_id}/tuning-params/modify-params

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region.

For details about how to obtain the project ID, see Obtaining a Project ID.

job_id

Yes

String

Task ID of a tenant in a region. If the task is a primary/standby task, the parent task ID is used.

For details about how to obtain the task ID, see Obtaining a Task ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

The content type. The value is application/json.

X-Auth-Token

Yes

String

User token obtained from IAM.

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

full_sync

No

Map<String,String>

Names and values of full migration parameters.

incre_capture

No

Map<String,String>

Names and values of incremental capture parameters.

incre_apply

No

Map<String,String>

Names and values of incremental replay parameters.

incre_relay

No

Map<String,String>

Names and values of incremental log extraction parameters. slotAdvanceInterval: the interval for advancing the logical replication slot of the source database.

recovery

No

Boolean

Initialization parameter. The value must be set to true for the first invoking. In other cases, this parameter is not specified.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

full_sync

Array of objects

Full migration tuning parameters.

For details, see Table 5.

incre_capture

Array of objects

Incremental capture tuning parameters.

For details, see Table 5.

incre_apply

Array of objects

Incremental replay tuning parameters.

For details, see Table 5.

incre_relay

Array of objects

Incremental log extraction tuning parameters.

For details, see Table 5.

modify_result

String

Whether the parameter modification is successful.

Table 5 Data structure description of fields full_sync, incre_capture, incre_apply, and incre_relay

Parameter

Type

Description

param_name

String

Parameter name.

param_value

String

Parameter value.

availability

String

Available or not.

range

String

Parameter value range.

Example Request

  • Setting the interval for advancing the logical replication slot of the specified source database for the task from GaussDB Centralized to Kafka 
    https://{endpoint}/v3/054c06d8aa00d39e2f6cc00176952b8b/job/1e3f710f-4df3-4fc9-8a29-0ec72c5jb2b3/tuning-params/modify-params

{
  "incre_relay" : {
    "slotAdvanceInterval" : "5"
  }
}
  • Example of initializing advanced parameters 
    https://{endpoint}/v3/054c06d8aa00d39e2f6cc00176952b8b/job/1e3f710f-4df3-4fc9-8a29-0ec72c5jb2b3/tuning-params/modify-params

{
  "recovery" : true
}

Example Response

Status code: 200

OK

{
  "full_sync" : [ ],
  "incre_capture" : [ ],
  "incre_apply" : [ ],
  "incre_relay" : [ {
    "param_name" : "slotAdvanceInterval",
    "param_value" : "5"
  } ],
  "modify_result" : "success"
}

Status Code

Status Code

Description

200

OK

Error Code

For details, see Error Code.