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

Querying Advanced Settings

Function

This API is used to query advanced settings.

URI

GET /v3/{project_id}/job/{job_id}/tuning-params/query-params

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region.

job_id

Yes

String

Task ID. If the task is a primary/standby task, the parent task ID is used.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

No

String

The content type. Its value is application/json.

X-Auth-Token

Yes

String

User token obtained from IAM.

X-Language

No

String

Request language type.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

full_sync

Array of TuningParameter objects

Full migration tuning parameters.

incre_capture

Array of TuningParameter objects

Incremental capture tuning parameters.

incre_apply

Array of TuningParameter objects

Incremental replay tuning parameters.

incre_relay

Array of TuningParameter objects

Incremental log extraction tuning parameters.

modify_result

String

Whether a parameter is successfully modified. This field is not returned when you query the parameter.

Table 4 TuningParameter

Parameter

Type

Description

param_name

String

Parameter name.

param_value

String

Parameter value.

availability

String

Available or not.

range

String

Value range.

Example Requests

Querying advanced settings

https://{endpoint}/v3/5237e10fe9aa4ad5b16b6a5245248314/job/da57dc88-1f98-4671-986b-1044e7cjb2b3/tuning-params/query-params

Example Responses

Status code: 200

OK

{
  "incre_capture" : [ {
    "param_name" : "hisKmsInfo",
    "param_value" : " ",
    "availability" : "true"
  } ],
  "incre_relay" : [ {
    "param_name" : "fetchLogByTable",
    "param_value" : "false",
    "availability" : "true",
    "range" : "true,false"
  }, {
    "param_name" : "excludeUsers",
    "param_value" : " ",
    "availability" : "true"
  }, {
    "param_name" : "slotAdvanceInterval",
    "param_value" : "1",
    "availability" : "true",
    "range" : "[1,2147483647]"
  } ]
}

Status Code

Status Code

Description

200

OK

Error Code

For details, see Error Code.