Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ HTAP (Standard Edition)/ Querying Database Parameter Settings for StarRocks Data Synchronization

Updated on 2025-09-04 GMT+08:00

Online Debugging

CLI Examples

View PDF

Querying Database Parameter Settings for StarRocks Data Synchronization

Function

This API is used to query database parameter settings for StarRocks data synchronization. Before calling this API:

Learn how to authorize and authenticate it.
Obtain the required region and endpoint.

URI

GET /v3/{project_id}/instances/{instance_id}/starrocks/databases/replication/database-parameters

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints N/A Range The value contains 32 characters. Only letters and digits are allowed. Default Value N/A
instance_id	Yes	String	Definition StarRocks instance ID, which is compliant with the UUID format. Constraints N/A Range The value contains 36 characters with a suffix of in17. Only letters and digits are allowed. Default Value N/A

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
add_task_scenario	No	String	Definition Whether database parameters can be modified when a subtask is added. Constraints Optional. Range N/A Default Value N/A
offset	No	String	Definition Index offset. If offset is set to N, the query starts from the N+1 piece of data. If the value is set to 0, indicating that the query starts from the first piece of data. The value must be a number but cannot be a negative number. Constraints N/A Range ≥ 0 Default Value 0
limit	No	String	Definition Number of records to be queried. Constraints N/A Range 1–100 Default Value 1
main_task_name	No	String	Definition Name of the main task corresponding to the new subtask. Constraints Optional. Range N/A Default Value N/A

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. To obtain this value, call the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the token value. Constraints N/A Range N/A Default Value N/A
X-Language	No	String	Definition Request language type. Constraints N/A Range en-us zh-cn Default Value en-us

Response Parameters

Status code: 200

**Table 4** Response body parameter
Parameter	Type	Description
db_parameters	Array of DbParameter objects	Definition Database parameters. Range N/A

**Table 5** DbParameter
Parameter	Type	Description
param_name	String	Constraints Parameter name. Range N/A
data_type	String	Constraints Parameter type. Range N/A
default_value	String	Constraints Default parameter value. Range N/A
value_range	String	Constraints Parameter value range. Range N/A
description	String	Constraints Parameter description. Range N/A
is_modifiable	String	Definition Whether database parameters can be modified when a subtask is added. Range N/A

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Request

Querying database parameter settings for data synchronization of a StarRocks instance with instance ID specified

GET https://{localhost}/v3/{project_id}/instances/{instance_id}/starrocks/databases/replication/database-parameters

Example Response

Status code: 200

Success.

{
  "db_parameters" : [ {
    "param_name" : "enable_chunk_level_dump",
    "data_type" : "String",
    "default_value" : "false",
    "value_range" : "true|false",
    "description" : "Whether to enable shard replication.",
    "is_modifiable" : "Yes"
  }, {
    "param_name" : "snapshot_with_lock",
    "data_type" : "String",
    "default_value" : "true",
    "value_range" : "true|false",
    "description" : "Whether a lock is added when a full snapshot is obtained. The default value is true.",
    "is_modifiable" : "Yes"
  }, {
    "param_name" : "sync_commit_interval_ms",
    "data_type" : "Integer",
    "default_value" : "5000",
    "value_range" : "1000-60000",
    "description" : "Timeout interval for batch commit. Data is committed when the timeout interval is reached or the buffer is full.",
    "is_modifiable" : "Yes"
  }, {
    "param_name" : "max_sync_commit_rows",
    "data_type" : "Integer",
    "default_value" : "500000",
    "value_range" : "500000-2000000",
    "description" : "Maximum number of rows allowed for each commit.",
    "is_modifiable" : "Yes"
  }, {
    "param_name" : "max_sync_commit_bytes",
    "data_type" : "Integer",
    "default_value" : "268435456",
    "value_range" : "10485760-1610612736",
    "description" : "Maximum number of bytes allowed for each commit.",
    "is_modifiable" : "Yes"
  }, {
    "param_name" : "max_full_sync_task_threads_num",
    "data_type" : "Integer",
    "default_value" : "1",
    "value_range" : "1-2",
    "description" : "Maximum threads allowed for full synchronization.",
    "is_modifiable" : "Yes"
  }, {
    "param_name" : "max_rows_per_chunk",
    "data_type" : "Integer",
    "default_value" : "0",
    "value_range" : "0-1000000",
    "description" : "Maximum number of rows per shard.",
    "is_modifiable" : "Yes"
  }, {
    "param_name" : "max_bytes_per_chunk",
    "data_type" : "Integer",
    "default_value" : "268435456",
    "value_range" : "33554432-1073741824",
    "description" : "Maximum number of bytes per shard.",
    "is_modifiable" : "Yes"
  }, {
    "param_name" : "binlog_expire_logs_seconds",
    "data_type" : "Integer",
    "default_value" : "86400",
    "value_range" : "0-604800",
    "description" : "Binlog retention period, which must be no greater than that of TaurusDB. The value 0 indicates that the retention period is not limited.",
    "is_modifiable" : "Yes"
  } ]
}

Status code: 400

Client error.

{
  "error_code" : "DBS.200022",
  "error_msg" : "Instance not found."
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: HTAP (Standard Edition)

Previous topic: Querying Configurations of a StarRocks Data Synchronization Task

Next topic: Querying Databases of a StarRocks Instance

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot