Help Center/ GaussDB(for MySQL)/ API Reference/ APIs (Recommended)/ HTAP (Standard Edition)/ Querying Database Parameter Settings for StarRocks Data Synchronization
Updated on 2024-09-11 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

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:

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

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

instance_id

Yes

String

StarRocks instance ID, which is compliant with the UUID format.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

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.

X-Language

Yes

String

Request language type. The default value is en-us. Values:

  • en-us
  • zh-cn

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

db_parameters

Array of DbParameter objects

Database parameter information.
Table 4 DbParameter

Parameter

Type

Description

param_name

String

Parameter name.

data_type

String

Parameter type.

default_value

String

Default parameter value.

value_range

String

Parameter value range.

description

String

Parameter description.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 6 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."
  }, {
    "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."
  }, {
    "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."
  }, {
    "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."
  }, {
    "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."
  }, {
    "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."
  }, {
    "param_name" : "max_rows_per_chunk",
    "data_type" : "Integer",
    "default_value" : "0",
    "value_range" : "0-1000000",
    "description" : "Maximum number of rows per shard."
  }, {
    "param_name" : "max_bytes_per_chunk",
    "data_type" : "Integer",
    "default_value" : "268435456",
    "value_range" : "33554432-1073741824",
    "description" : "Maximum number of bytes per shard."
  }, {
    "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 GaussDB(for MySQL). The value 0 indicates that the retention period is not limited."
  } ]
}

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)