BASE DE CONNAISSANCES

Les points de terminaison XML ne sont plus disponibles dans Tableau Server


Date de publication : 15 Mar 2017
Date de dernière modification : 20 Jul 2023

Question

Depuis la distribution de Tableau Server version 10.0 en août 2016, les points de terminaison XML (par exemple http://MY-SERVER/users.xml) n'ont pas été disponibles en raison d'un changement dans les processus Tableau Server. Les utilisateurs dépendant de ces points de terminaison doivent porter leur code de manière à utiliser l'API REST.

Environnement

  • Tableau Server 10.0 et versions ultérieures
  • Points de terminaison XML

Réponse

État dans les versions actuelles et futures de Tableau Server

Dans Tableau Server 9.3, le processus wgserver est désactivé par défaut. (Les appels API REST sont traités par un processus différent.) Si vous souhaitez continuer à utiliser les points de terminaison XML dans Tableau Server 9.3, vous devez explicitement activer le processus à l'aide des commandes suivantes :

tabadmin stop 
tabadmin set wgserver.enabled true 
tabadmin set wgserver.xmlapi.enabled true 
tabadmin set worker0.wgserver.procs 1 
tabadmin configure 
tabadmin start 


Important : Depuis Tableau Server 10.0, le processus wgserver a été entièrement supprimé et vous ne pourrez plus utiliser du tout des points de terminaison XML.

Parité des points de terminaison XML

À mesure que nous avons ajouté de nouvelles fonctionnalités à l'API REST, les points de terminaison XML se sont avérés de moins en moins nécessaires. Les informations renvoyées par les points de terminaison XML sont désormais disponibles à l'aide de l'API REST, ou il a été déterminé que cette fonctionnalité ne nécessitait pas actuellement un point de terminaison API.

Il n'existe pas nécessairement un mappage un-à-un entre un point de terminaison XML et une API REST. Par exemple, un point de terminaison XML peut avoir renvoyé des informations dans un format différent de celui des informations envoyées par une méthode API REST.

Le tableau suivant montre les équivalents entre les points de terminaison XML et les méthodes API REST.

Point de terminaison XMLMéthode(s) API REST
auth.xmlSign In
data_connections.xmlQuery Workbook Connections
datasources.xmlQuery Datasources
groups.xmlQuery Groups
projects.xmlQuery Projects
schedules.xmlQuery Schedules
site_tasks.xmlQuery Extract Refresh Tasks
sites.xmlInterroger des sites
Interroger un site
tags.xmlInterroger une source de données
Interroger un classeur
Interroger des classeurs pour l'utilisateur
tasks.xmlQuery Extract Refresh Tasks
users.xmlObtenir des utilisateurs dans le groupe
Obtenir des utilisateurs sur le site
views.xmlInterroger les vues pour le site
Interroger des vues pour le classeur
workbooks.xmlInterroger un classeur
Interroger des classeurs pour l'utilisateur

Avec une exception (voir la section suivante), si un point de terminaison n'est pas répertorié dans le tableau précédent, il n'existe pas d'équivalent dans l'API REST.

systeminfo.xml

Le point de terminaison systeminfo.xml continue d'être disponible. Ce point de terminaison fournit des informations sur l'état actuel des processus serveur. Pour plus d'informations, consultez Obtenir le statut du processus en XML dans la documentation de Tableau Server.

Informations supplémentaires

Arrière-plan

Les composants Tableau Server sont occasionnellement remodelés afin d'améliorer les performances, l'évolutivité et autres raisons. Dans le cadre de cet effort, le processus du serveur API (wgserver) n'est plus nécessaire dans Tableau Server. La fonctionnalité fournie à l'origine par ce composant est désormais intégrée dans d'autres composants.

Points de terminaison XML

Pendant plusieurs versions, Tableau Server a inclus le processus wgserver qui était conçu pour faciliter la gestion de contenu. Un effet secondaire du mode d'implémentation de ce processus était que Tableau Server permettait aux utilisateurs d'envoyer des demandes à des points de terminaison XML. Par exemple, les utilisateurs ont pu envoyer des demandes de ce type, qui ont renvoyé des informations relatives aux utilisateurs définis sur le serveur.

http://MY-SERVER/users.xml

Les points de terminaison XML n'ont jamais été documentés et n'étaient pas pris en charge. Si vous avez une fonctionnalité d'application dépendant de ces points de terminaison, vous devez mettre à jour votre code de manière à utiliser REST API à la place.

Raisons du changement

Comme indiqué, les points de terminaison XML n'étaient pas une fonctionnalité prise en charge. Ils étaient un effet secondaire résultant de la mise en œuvre de wgserver. Du fait qu'ils n'étaient pas pris en charge, nous n'avons pas cherché à mettre à jour les points de terminaison de manière à héberger de nouvelles fonctionnalités sur le serveur, ou à corriger des bogues. De plus, les points de terminaison XML étaient parfois instables. Par exemple, demander des ensembles de données très volumineux à l'aide d'un point de terminaison XML pouvait entraîner des erreurs ou des pannes.

Cet article vous a-t-il permis de résoudre le problème ?