Tester la configuration de la connexion

Version 3.1.23.6

Testez une configuration de connexion.

Notez que la propriété "dialect" d'une connexion comporte une propriété "connection_tests" qui répertorie les types de tests spécifiques compatibles avec la connexion.

Le débit de cette API est limité.

Les tests non acceptés dans la requête seront ignorés.

Demande

PUT /connections/test
Type de données
Description
Demande
HTTPRequest
body
Corps HTTP
Développer la définition HTTPBody...
body
Connexion
Développer la définition de DBConnection...
peut
objet
Opérations que l'utilisateur actuel peut effectuer sur cet objet
name
string
Nom de la connexion. Également utilisé comme identifiant unique
dialecte
Détails du dialecte SQL (lecture seule)
extraits
pdts_enabled
booléen
Vrai si les tables dérivées persistantes sont activées sur cette connexion
hôte
string
Nom ou adresse du serveur, ou chaîne "localhost" en cas de connexion sur un tunnel SSH.
port
string
Numéro de port sur le serveur. Si la connexion passe par un tunnel SSH, le port local associé au tunnel SSH.
nom d'utilisateur
string
Nom d'utilisateur pour l'authentification du serveur
mot de passe
string
(Écriture seule) Mot de passe pour l'authentification du serveur
utilise_oauth
booléen
Indique si la connexion utilise OAuth pour l'authentification.
certificat
string
(Écriture seule) Corps de certificat encodé en base64 pour l'authentification du serveur (si approprié pour le dialecte).
type_de_fichier
string
(Écriture seule) Type de fichier de clé de certificat : .json ou .p12
base de données
string
Nom de la base de données
db_fuseau horaire
string
Fuseau horaire de la base de données
requête_fuseau horaire
string
Fuseau horaire à utiliser dans les requêtes
schema
string
Nom du schéma
max_connections
integer
Nombre maximal de connexions simultanées à utiliser
Facturation_gigaoctets_max
string
Taille maximale de la requête en Go (BigQuery uniquement, peut être un nom d'attribut utilisateur)
ssl
booléen
Utiliser le protocole SSL/TLS lors de la connexion au serveur
vérifier_ssl
booléen
Vérifier le protocole SSL
tmp_db_name (nom de la tmp_db)
string
Nom de la base de données temporaire (si utilisée)
jdbc_additional_params
string
Paramètres supplémentaires à ajouter à la chaîne de connexion JDBC
pool_timeout
integer
Délai d'expiration du pool de connexions, en secondes
dialecte
string
(Lecture/Écriture) Nom du dialecte SQL
liens_data_studio_support
booléen
La connexion aux bases de données permet d'explorer des données dans Studio
créé le
string
Date de création de cette connexion
user_id
string
ID de l'utilisateur qui a modifié cette configuration de connexion pour la dernière fois
exemple
booléen
S'agit-il d'un exemple de connexion ?
identifiants_utilisateur_db
booléen
(Fonctionnalité à accès limité) Les identifiants de la base de données sont activés par utilisateur. L'activation supprimera le nom d'utilisateur et le mot de passe précédemment définis
user_attribute_fields
chaîne[]
Maintenance_cron
string
Chaîne Cron spécifiant quand effectuer la maintenance (par exemple, les vérifications et les suppressions de déclencheurs PDT)
dernière_génération
string
Horodatage Unix au début du processus de vérification du déclencheur PDT terminé
Dernière_retrait
string
Horodatage Unix au début du dernier processus de PDT terminé
sql_runner_precache_tables
booléen
Effectuer une mise en cache préalable des tables dans l'exécuteur SQL
écriture_sql_avec_schéma_info
booléen
Télécharger un schéma d'informations pour l'écriture SQL
after_connect_statements
string
Instructions SQL (séparées par un point-virgule) à émettre après la connexion à la base de données. Nécessite la fonctionnalité de licence "custom_after_connect_statements"
ppd_context_override
db_connection_override pour cette connexion dans le contexte de maintenance "pdt"
géré
booléen
Cette connexion est-elle créée et gérée par Looker ?
utilise_ntn
booléen
Activer les connexions TNS (Transparent Network Substrate)
query
Requête HTTP
Développer la définition de la requête HTTP...
tests
chaîne[]

Réponse

200: Résultats du test

Type de données
Description
peut
objet
Opérations que l'utilisateur actuel peut effectuer sur cet objet
chaîne_connexion
string
Chaîne de connexion JDBC. (informations renseignées uniquement lors du test "connect")
Message
string
Message de résultat du test
name
string
Nom du test
état
string
Code de résultat du test

400 Bad Request

Type de données
Description
(objet)
Message
string
Infos sur l'erreur
documentation_url
string
Lien vers la documentation

404: introuvable

Type de données
Description
(objet)
Message
string
Infos sur l'erreur
documentation_url
string
Lien vers la documentation

429 : Too Many Requests

Type de données
Description
(objet)
Message
string
Infos sur l'erreur
documentation_url
string
Lien vers la documentation