Testar configuração da conexão

Versão 3.1.23.6

Testar uma configuração de conexão.

Observe que a propriedade "dialect" de uma conexão tem uma propriedade "connection_tests" que lista os tipos específicos de testes compatíveis com a conexão.

Essa API tem limitação de taxa.

Os testes não compatíveis na solicitação serão ignorados.

Solicitação

PUT /connections/test
Tipo de dados
Descrição
Solicitação
HTTPRequest
body
Corpo HTTP
Expandir definição HTTPBody...
body
DBConnection (em inglês)
Conexão
Expandir a definição de DBConnection...
pode
objeto
Operações que o usuário atual pode realizar neste objeto
nome
string
Nome da conexão. Também usado como identificador exclusivo
dialeto
Detalhes somente leitura do SQL Dialect
snippets
pdts_enabled
booleano
Verdadeiro se as TDPs estiverem ativadas nessa conexão
host
string
Nome do host/endereço do servidor ou a string "localhost" no caso de uma conexão por meio de um túnel SSH.
porta
string
Número da porta no servidor. Se a conexão for feita por um túnel SSH, a porta local associada ao túnel SSH.
nome de usuário
string
Nome de usuário para autenticação do servidor
senha
string
(Somente gravação) Senha para autenticação do servidor
usa_oauth
booleano
Se a conexão usa OAuth para autenticação.
certificado
string
(Somente gravação) Corpo de certificado codificado em Base64 para autenticação de servidor (quando apropriado para dialeto).
tipo_de_arquivo
string
Tipo de arquivo de chave de certificado (somente gravação): .json ou .p12
Banco de dados
string
Nome do banco de dados
db_timezone
string
Fuso horário do banco de dados
fuso horário_de_consulta
string
Fuso horário a ser usado em consultas
schema
string
Nome do esquema
max_connections
integer
Número máximo de conexões simultâneas a serem usadas
max_billing_gigabytes
string
Tamanho máximo da consulta em GB (somente BigQuery, pode ser um nome user_attribute)
ssl
booleano
Usar SSL/TLS ao conectar ao servidor
verificar_ssl
booleano
Verificar o SSL
tmp_db_name
string
Nome do banco de dados temporário (se usado)
jdbc_additional_params
string
Parâmetros adicionais a serem adicionados à string de conexão JDBC
pool_timeout
integer
Tempo limite do pool de conexão, em segundos
dialeto_nome
string
(Leitura/gravação) Nome do dialeto SQL
links_dados_do_studio_de_suporte
booleano
A conexão com o banco de dados é compatível com o Open Data Studio na exploração
criado_em
string
Data de criação desta conexão
user_id
string
ID do usuário que modificou esta configuração de conexão pela última vez
exemplo
booleano
Esse é um exemplo de conexão?
Credenciais_usuário_db
booleano
(Recurso com acesso limitado) As credenciais de db estão ativadas para o usuário. A ativação removerá o nome de usuário e a senha definidos anteriormente
campos_do_atributo_do_usuário
string[]
manutenção_cron
string
String cron que especifica quando a manutenção, como verificações e quedas de acionadores de PDT, deve ser realizada
último_regen_at
string
Carimbo de data/hora do Unix no início do último processo de verificação de gatilho de TDP
last_reap_at
string
Carimbo de data/hora Unix no início do último processo de coleta PDT concluído
sql_runner_precache_tables
booleano
Pré-armazenar tabelas em cache no SQL Runner
sql_writing_with_info_schema
booleano
Buscar esquema de informações para gravação SQL
extratos after_connect_statements
string
Instruções SQL (separadas por ponto e vírgula) que vão ser emitidas após a conexão com o banco de dados. Requer o recurso de licença "custom_after_connect_statements"
pdt_context_override
db_connection_override para esta conexão no contexto de manutenção do `pdt`
managed
booleano
Esta conexão foi criada e gerenciada pelo Looker
utiliza_tns
booleano
Ativar conexões de sub-rede de rede transparente (TNS, na sigla em inglês)
consulta
Consulta HTTP
Expandir a definição de HTTPQuery...
testes
string[]

Resposta

200: resultados do teste

Tipo de dados
Descrição
pode
objeto
Operações que o usuário atual pode realizar neste objeto
string_de_conexão
string
String de conexão JDBC. (preenchido apenas no teste "connect")
mensagem
string
Mensagem de resultado do teste
nome
string
Nome do teste
status
string
Código do resultado do teste

400: Solicitação inválida

Tipo de dados
Descrição
(objeto)
mensagem
string
Detalhes do erro
url_da_documentação
string
Link da documentação

404: não encontrado

Tipo de dados
Descrição
(objeto)
mensagem
string
Detalhes do erro
url_da_documentação
string
Link da documentação

429: Solicitações demais

Tipo de dados
Descrição
(objeto)
mensagem
string
Detalhes do erro
url_da_documentação
string
Link da documentação