Consulta de tarefas de sincronização de dados de uma instância do StarRocks
Função
Essa API é usada para consultar tarefas de sincronização de dados de uma instância do StarRocks. Antes de chamar essa API:
- Saiba como autorizá-la e autenticá-la.
- Obtenha a região e o ponto de extremidade necessários.
URI
GET /v3/{project_id}/instances/{instance_id}/starrocks/databases/replication
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
project_id |
Sim |
String |
ID do projeto de um locatário numa região. Para obter esse valor, consulte Obtenção de um ID de projeto. |
|
instance_id |
Sim |
String |
ID da instância do StarRocks, que é compatível com o formato UUID. |
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
limit |
Não |
String |
Número de registros a serem consultados. Número de tarefas de sincronização de dados exibidas em cada página. |
|
offset |
Não |
String |
Deslocamento do índice. Se offset estiver definido como N, a consulta começará a partir da parte N+1 dos dados. O valor é 0 por padrão, indicando que a consulta começa a partir da primeira parte dos dados. O valor deve ser um número, mas não pode ser um número negativo. |
Parâmetros de solicitação
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
X-Auth-Token |
Sim |
String |
Token do usuário. Para obter esse valor, chame a API do IAM para obter um token de usuário. O valor de X-Subject-Token no cabeçalho da resposta é o valor do token. |
|
X-Language |
Sim |
String |
Tipo de linguagem da solicitação. O valor padrão é en-us. Valores:
|
Parâmetros de resposta
Código de status: 200
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
total_count |
String |
Número total de tarefas de sincronização de dados. |
|
replications |
Array of StarRocksReplicationInfo objects |
Informações sobre tarefas de sincronização de dados. |
|
ext_text |
String |
Campo estendido. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
source_database |
String |
Banco de dados TaurusDB. O valor pode conter de 3 a 1024 caracteres. |
|
target_database |
String |
Banco de dados de destino. O valor pode conter de 3 a 128 caracteres. Somente letras maiúsculas, letras minúsculas, dígitos e sublinhados (_) são permitidos. |
|
task_name |
String |
Nome da tarefa de sincronização. O valor pode conter de 3 a 128 caracteres. Somente letras maiúsculas, letras minúsculas, dígitos e sublinhados (_) são permitidos. |
|
status |
String |
Status atual.
|
|
stage |
String |
Estágio de sincronização.
|
|
percentage |
String |
Porcentagem de progresso. |
|
catchup_stage |
String |
Estágio de recuperação.
|
|
catchup_percentage |
String |
Porcentagem de progresso de recuperação. |
Código de status: 400
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
error_code |
String |
Código de erro. |
|
error_msg |
String |
Mensagem de erro. |
Código de status: 500
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
error_code |
String |
Código de erro. |
|
error_msg |
String |
Mensagem de erro. |
Exemplo de solicitação
Consulta das 10 primeiras tarefas de sincronização na primeira página
GET https://{localhost}/v3/{project_id}/instances/{instance_id}/starrocks/databases/replication?offset=1&limit=10
Exemplo de resposta
Código de status: 200
Bem-sucedido.
{
"total_count" : 1,
"replications" : [ {
"source_database" : "source_database",
"target_database" : "target_database",
"task_name" : "task_name",
"status" : "Yes",
"stage" : "Incremental",
"percentage" : 100,
"catchup_stage" : null,
"catchup_percentage" : 0
} ],
"ext_text" : null
}
Código de status: 400
Erro do cliente.
{
"error_code" : "DBS.200022",
"error_msg" : "Instance not found."
}
Código de status
Para mais detalhes, consulte Códigos de status.
Código de erro
Para mais detalhes, consulte Códigos de erro.
