ナレッジベース

Tableau Server では XML エンドポイントは利用できなくなりました


発行: 15 Mar 2017
最終修正日: 20 Jul 2023

ご質問

2016 年 8 月の Tableau Server バージョン 10.0 のリリース以降、Tableau Server プロセスの変更により XML エンドポイント (http://MY-SERVER/users.xml など) は使用できなくなりました。これらのエンドポイントに依存しているユーザーは、REST API を使用するようにコードを移植する必要があります。

環境

  • Tableau Server 10.0 以降
  • XML エンドポイント

回答

Tableau Server の現在および将来のバージョンの状況

Tableau Server 9.3 では、wgserver プロセスは既定で無効化されています (REST API 呼び出しは別のプロセスで処理されます)。XML エンドポイントの使用を Tableau Server 9.3 で継続する場合は、次のコマンドを使用してプロセスを明示的に有効化する必要があります。

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


重要: Tableau Server 10.0 以降、wgserver プロセスは完全に削除されているため、XML エンドポイントは一切使用できません。

XML エンドポイント パリティ

新しい機能を追加して REST API の拡張を行ってきたことで、XML エンドポイントの必要性が減少しました。XML エンドポイントによって返されていた情報は、現在は REST API を使用して利用可能であるか、または API エンドポイントを現在必要とする機能でないことが確定されました。

XML エンドポイントと REST API 間のマッピングは必ずしも 1 対 1 ではありません。たとえば、REST API メソッドによる情報の返し方とは異なる形式で XML エンドポイントが情報を返していた可能性もあります。

次の表は、XML エンドポイントと REST API メソッド間の対応を示しています。

XML エンドポイント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.xmlサイトをクエリ
サイトをクエリ
tags.xmlデータソースのクエリ
ワークブックをクエリ
ユーザー用のワークブックをクエリ
tasks.xmlQuery Extract Refresh Tasks
users.xmlグループ内のユーザーの取得
サイトのユーザーを取得
views.xmlサイトのビューをクエリ
ワークブック用のビューをクエリ
workbooks.xmlワークブックをクエリ
ユーザー用のワークブックをクエリ

1 つの例外を除いて (次のセクションを参照)、上の表にエンドポイントがリストされていない場合、それに対応するメソッドが REST API に存在しないということです。

systeminfo.xml

systeminfo.xml エンドポイントは引き続き使用できます。このエンドポイントは、サーバー プロセスの現在のステータスに関する情報を提供します。詳細については、Tableau Server ドキュメントの「プロセス ステータスを XML として取得」を参照してください。

詳細情報

バックグラウンド

Tableau Server のコンポーネントは、パフォーマンスやスケーラビリティの向上およびその他の理由により再設計される場合があります。その一環として、API サーバー プロセス (wgserver) が Tableau Server では必要なくなりました。 元々それらのコンポーネントによって提供されていた機能は、現在は他のコンポーネントに組み込まれています。

XML エンドポイント

いくつかのバージョンでは、コンテンツ管理を促進するために設計された wgserver プロセスが Tableau Server に含まれています。このプロセスの実装方法による副次的効果として、Tableau Server により XML エンドポイントへの要求が許可されていました。たとえば、ユーザーは次のような要求を行うことが可能でした。この要求は、サーバー上で定義されたユーザーに関する情報を返します。

http://MY-SERVER/users.xml

XML エンドポイントについては、文書化もサポートも一切されていません。 これらのエンドポイントに依存するアプリケーション機能がある場合は、代わりに REST API を使用するようにコードを更新する必要があります。

変更理由

前述のとおり、XML エンドポイントはサポートされていた機能ではなく、wgserver の実装過程に生じる副次的効果でした。サポートされていない機能であったため、サーバー上の新しい機能に対応するようエンドポイントを更新したり、バグを修正したりしませんでした。また、XML エンドポイントは不安定になる場合がありました。たとえば、XML エンドポイントを使用して非常に大量のデータセットを要求すると、エラーやハングアップが生じる可能性がありました。

この記事で問題は解決しましたか?