BASE DE DADOS DE CONHECIMENTO

Endpoints XML não mais disponíveis no Tableau Server


Publicado: 15 Mar 2017
Data da última modificação: 20 Jul 2023

Pergunta

Desde o lançamento da versão 10.0 do Tableau Server, em agosto de 2016, os endpoints XML (por exemplo, http://MY-SERVER/users.xml) não estavam disponíveis, devido a uma alteração nos processos do Tableau Server. Os usuários que dependem desses endpoints devem portar os códigos para usar a REST API.

Ambiente

  • Tableau Server 10.0 e versões posteriores
  • Endpoints XML

Resposta

Status nas versões atuais e futuras do Tableau Server

No Tableau Server 9.3, o processo wgserver está desativado por padrão. (As chamadas da REST API são manipuladas por um processo diferente). Caso deseje continuar a usar os endpoints XML no Tableau Server 9.3, é necessário habilitar o processo usando os comandos a seguir:

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


Importante: Do Tableau Server 10.0 em diante, o processo wgserver foi removido inteiramente e você não poderá usar os endpoints XML de maneira alguma.

Igualdade do endpoint XML

Como estendemos a REST API com a nova funcionalidade, há cada vez menos necessidade para os endpoints XML. As informações retornadas pelos endpoints XML agora estão disponíveis usando a REST API, ou não foram determinadas como funcionalidades que atualmente necessitam de um endpoint de API.

Não há necessariamente um mapeamento um por um entre um XML e uma REST API; por exemplo, um XML pode ter retornado uma informação em um formato diferente de como a mesma é retornada por um método da REST API.

A tabela a seguir mostra equivalentes entre endpoints XML e métodos da REST API.

Endpoint XMLMétodos da REST API
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.xmlConsultar sites
Consultar site
tags.xmlConsultar fontes de dados
Consultar pasta de trabalho
Consultar pastas de trabalho para usuário
tasks.xmlQuery Extract Refresh Tasks
users.xmlObter usuários no grupo
Obter usuários no site
views.xmlConsultar exibições do site
Consultar exibições para pasta de trabalho
workbooks.xmlConsultar pasta de trabalho
Consultar pastas de trabalho para usuário

Com uma exceção (consulte a próxima seção), se um endpoint não estiver listado na tabela acima, não existe equivalente na REST API.

systeminfo.xml

O endpoint systeminfo.xml continua disponível. Esse endpoint fornece informações sobre o status atual dos processos do servidor. Para obter mais informações, consulte Obter status de processo como XML na documentação do Tableau Server.

Informações adicionais

Em segundo plano

Os componentes do Tableau Server são reprojetados ocasionalmente para um melhor desempenho, escalabilidade, entre outras razões. Como parte desse empenho, o processo do Servidor de API (wgserver) não é mais necessário no Tableau Server. A funcionalidade originalmente fornecida por esse componente agora é incluída em outros componentes.

Endpoints XML

Em diversas versões, o Tableau Server incluiu o processo wgserver, projetado para facilitar o gerenciamento de conteúdo. Um efeito colateral de como esse processo foi implementado foi o Tableau Server permitir que usuários fizessem solicitações a endpoints XML. Por exemplo, os usuários foram capazes de fazer solicitações como a seguinte, que retornou informações sobre usuários definidos no servidor:

http://MY-SERVER/users.xml

Os endpoints XML nunca foram documentados e não eram suportados. Se você possuir funcionalidades de aplicativos que dependam desses endpoints, atualize o código para usar a REST API em vez disso.

Motivos para alteração

Como observado, os endpoints XML não eram um recurso suportado; eram um efeito colateral da maneira que o wgserver foi implementado. Como não eram suportados, não nos empenhamos em atualizar os endpoints para acomodarem a nova funcionalidade no servidor, ou para corrigir falhas. Além disso, os endpoints XML tinham momentos de instabilidade; por exemplo, solicitar conjuntos de dados muito grandes usando um endpoint XML poderia resultar em erros ou travamentos.

Este artigo resolveu o problema?