Consulta de configuraciones de una tarea de sincronización de datos de StarRocks
Función
Esta API se utiliza para consultar configuraciones de una tarea de 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/configuration
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ámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
task_name |
Sí |
String |
Nombre de la tarea de sincronización de datos. El valor puede contener de 3 a 128 caracteres. Solo se permiten mayúsculas, minúsculas, dígitos y guiones bajos (_). |
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 |
---|---|---|
source_instance_id |
String |
ID de instancia de TaurusDB. |
source_node_id |
String |
ID del nodo de TaurusDB. |
database_info |
DataBaseInfo object |
Información de configuración de la base de datos de TaurusDB. |
table_infos |
Array of TableConfigCheckResult objects |
Configuraciones de tablas. |
table_repl_config |
TableReplConfig object |
Configuraciones de sincronización de tablas. |
new_table_repl_config |
TableReplConfig object |
Configuraciones de sincronización de tablas actualizadas. |
target_database_name |
String |
Nombre de la base de datos de destino. El valor puede contener de 3 a 128 caracteres. Solo se permiten mayúsculas, minúsculas, dígitos y guiones bajos (_). |
is_tables_change |
Boolean |
Si hay algún cambio en el ámbito de sincronización (tablas a sincronizar). |
last_error_of_alter_table |
String |
Excepción sobre la última operación de ALTER TABLE. |
Parámetro |
Tipo |
Descripción |
---|---|---|
database_name |
String |
Nombre de la base de datos. |
db_config_check_results |
Array of DbConfigCheckResult objects |
Resultado de la comprobación de la configuración de la base de datos. |
Parámetro |
Tipo |
Descripción |
---|---|---|
param_name |
String |
Nombre del parámetro. El nombre puede contener de 3 a 128 caracteres. |
value |
String |
Valor del parámetro. El valor puede contener de 1 a 64 caracteres. |
check_result |
String |
Resultado de la comprobación. Valores:
|
Parámetro |
Tipo |
Descripción |
---|---|---|
table_name |
String |
Nombre de tabla.
|
table_config |
String |
Ítem de configuración de tabla.
|
check_result |
String |
Resultado de la comprobación. Valor: success o fail
|
Parámetro |
Tipo |
Descripción |
---|---|---|
repl_type |
String |
Tipo de sincronización de tabla.
|
repl_scope |
String |
Ámbito de sincronización de tablas.
|
tables |
Array of strings |
Tablas incluidas en la lista blanca o en la lista negra. |
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 configuraciones de la tarea de sincronización de datos taskName
GET https://{localhost}/v3/{project_id}/instances/{instance_id}/starrocks/databases/replication/configuration?task_name=taskName
Ejemplo de la respuesta
Código de estado: 200
Operación exitosa.
{ "source_instance_id" : "source_instance_id", "target_database_name" : "target_database_name", "source_node_id" : "source_node_id", "database_info" : { "database_name" : "database_name", "db_config_check_results" : [ { "param_name" : "default_isolation_level", "value" : "QUERY_SNAPSHOT", "check_result" : "success" }, { "param_name" : "enable_snapshots", "value" : "true", "check_result" : "failed" } ] }, "table_info" : [ ], "table_repl_config" : { "repl_type" : "exclude_tables", "repl_scope" : "all", "tables" : [ ] }, "new_table_repl_config" : { }, "is_tables_change" : false, "last_error_of_alter_table" : "" }
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.