Consulta de valores de parámetros de base de datos para la sincronización de datos de StarRocks
Función
Esta API se utiliza para consultar la configuración de parámetros de base de datos para la sincronización de datos de StarRocks. Antes de invocar a esta API:
- Aprender cómo autorizar y autenticarla.
- Obtenga la región y el punto de conexión requeridos.
URI
GET /v3/{project_id}/instances/{instance_id}/starrocks/databases/replication/database-parameters
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
project_id |
Sí |
String |
ID de proyecto de un tenant en una región. Para obtener este valor, consulte Obtención de un ID de proyecto. |
instance_id |
Sí |
String |
ID de instancia de StarRocks, que es compatible con el formato UUID. |
Parámetros de solicitud
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
X-Auth-Token |
Sí |
String |
Token de usuario. Para obtener este valor, invoque a la API de IAM para obtener un token de usuario. El valor de X-Subject-Token en el encabezado de respuesta es el valor del token. |
X-Language |
Sí |
String |
Tipo de idioma de solicitud. El valor predeterminado es en-us. Valores:
|
Parámetros de respuesta
Código de estado: 200
Parámetro |
Tipo |
Descripción |
---|---|---|
db_parameters |
Array of DbParameter objects |
Información de parámetros de base de datos. |
Parámetro |
Tipo |
Descripción |
---|---|---|
param_name |
String |
Nombre del parámetro. |
data_type |
String |
Tipo de parámetro. |
default_value |
String |
Valor de parámetro predeterminado. |
value_range |
String |
Rango de valores de parámetros. |
description |
String |
Descripción del parámetro. |
Código de estado: 400
Parámetro |
Tipo |
Descripción |
---|---|---|
error_code |
String |
Código de error. |
error_msg |
String |
Mensaje de error. |
Código de estado: 500
Parámetro |
Tipo |
Descripción |
---|---|---|
error_code |
String |
Código de error. |
error_msg |
String |
Mensaje de error. |
Ejemplo de la solicitud
Consulta de valores de parámetros de base de datos para la sincronización de datos de una instancia de StarRocks con el ID de instancia especificado
GET https://{localhost}/v3/{project_id}/instances/{instance_id}/starrocks/databases/replication/database-parameters
Ejemplo de la respuesta
Código de estado: 200
Operación exitosa.
{ "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 TaurusDB. The value 0 indicates that the retention period is not limited." } ] }
Código de estado: 400
Error de cliente.
{ "error_code" : "DBS.200022", "error_msg" : "Instance not found." }
Código de estado
Para más detalles, véase Códigos de estado.
Código de error
Para más detalles, véase Códigos de error.