Consulta de configurações de LTS de uma instância
Função
Essa API é usada para consultar configurações de LTS de uma instância. 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}/clickhouse/instances/logs/lts-configs
| 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. |
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| instance_id | Não | String | ID da instância do ClickHouse, que é compatível com o formato UUID. |
| enterprise_project_id | Não | String | ID do projeto empresarial. |
| instance_name | Não | String | Nome da instância. |
| limit | Não | Integer | Número de registros a serem consultados. O valor padrão é 10. O valor não pode ser um número negativo. O valor mínimo é 1 e o valor máximo é 100. |
| offset | Não | Integer | Deslocamento do índice. O valor padrão é 0. Se offset estiver definido como N, a consulta de recursos começará a partir da parte de dados N+1. Se o valor for definido como 0, indicando que a consulta começa a partir do primeiro dado. 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 | Não | 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 |
|---|---|---|
| instance_lts_configs | Array of ChInstanceLtsConfigs objects | Configurações de LTS de uma instância. |
| total_count | Integer | Número total de instâncias. |
| Parâmetro | Tipo | Descrição |
|---|---|---|
| lts_configs | Array of ChLtsConfigs objects | Configurações de LTS de uma instância. |
| instance | instance object | Informações da instância de HTAP. |
| Parâmetro | Tipo | Descrição |
|---|---|---|
| log_type | String | Tipo de registro. |
| lts_group_id | String | ID do grupo de logs do LTS. |
| lts_stream_id | String | ID de fluxo de log do LTS. |
| enabled | String | Se as configurações de LTS devem ser ativadas. |
| Parâmetro | Tipo | Descrição |
|---|---|---|
| id | String | ID da instância do ClickHouse. |
| name | String | Nome da instância. |
| mode | String | Função principal/em espera de uma instância. |
| engine_name | String | Tipo de mecanismo. |
| engine_version | String | Versão do mecanismo. |
| status | String | Status da instância. |
| enterprise_project_id | String | ID do projeto empresarial. |
| enterprise_project_name | String | Nome do projeto empresarial. |
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 de configurações de LTS de uma instância
GET https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/logs/clickhouse/lts-configs?instance_id=faf2cbf7f6cb422d83e61dbcc3e87023in07 Exemplo de resposta
Código de status: 200
Bem-sucedido.
{
"instance_lts_configs" : [ {
"lts_configs" : [ {
"log_type" : "slow_log",
"lts_group_id" : "460d8437-9dcb-47d0-8c56-5758f2042272",
"lts_stream_id" : "bad1ca5d-e347-437f-be89-f2e08ce117b8",
"enabled" : false
} ],
"instance" : {
"id" : "4c2614fe03ae4ec28184a277b8c00c03in07",
"name" : "gauss-8c01",
"mode" : "Cluster",
"engine_name" : "clickhouse",
"engine_version" : "2.0.48",
"status" : "normal",
"enterprise_project_id" : "0",
"enterprise_project_name" : "string"
}
} ],
"total_count" : 1
} Código de status
| Código de status | Descrição |
|---|---|
| 200 | Bem-sucedido. |
| 400 | Erro do cliente. |
| 500 | Erro no servidor. |
Código de erro
Para obter detalhes, consulte Códigos de erro.