初期取り込みステータスの取得
tsm maintenance metadata-services コマンドを使用して Tableau メタデータ API を有効にした後、バックフィル API を使用して初期取り込みの進行状況を監視し、コンテンツと系列のバックフィルのステータス情報を取得できます。
以下に説明する手順は、サーバー管理者が実行する必要があり、「Tableau Catalog の有効化」トピックのステップ 7: 初期取り込みの進行状況を監視し、その状態を検証すると組み合わせて使用することをお勧めします。
ステップ 1: REST API を使用して認証する
バックフィル API にアクセスするには、最初に Tableau Server に対して認証を行い、トークンを取得する必要があります。この操作は、Tableau REST API を使用してで実行できます。詳細については、REST API ヘルプの「サインインとサインアウト (認証)」(新しいウィンドウでリンクが開く)(英語) を参照してください。
または、管理者の認証資格情報を使用して Tableau Server にサインインできます。
ステップ 2: GET 要求を実行する
次の GET 要求を行うか、URL をブラウザーに貼り付けます。
http://my_tableau_server/api/metadata/v1/control/backfill/status
リクエストは、最初にコンテンツのバックフィルに関する情報を返します。コンテンツのバックフィルが完了すると、系列のバックフィル情報が返されます。
- コンテンツのバックフィルの場合、リクエストは、Tableau Server で使用可能なコンテンツに応じて、各コンテンツ タイプのステータスの概要と追加のステータス情報を返します。各コンテンツ タイプのインデックス作成は同時に実行されます。
- 系列のバックフィルの場合、リクエストはステータスの概要を返します。
応答のステータス値
以下の値は、バックフィル API によって返されます。
contentBackfillTotalDurationSecondsとlineageBackfillTotalDurationSecondsは、それぞれのバックフィル タイプでどれくらい時間が経過したかを秒単位で示します。backfillCompleteがtrueの場合、contentBackfillTotalDurationSecondsとlineageBackfillTotalDurationSecondsは、それぞれのバックフィル タイプの完了にかかった合計時間を示します。
コンテンツのバックフィルの場合:
contentTypeは、コンテンツ タイプPublishedDatasource、Database、DatabaseTable、Metric、Workbook、およびFlowを示します。contentIdは、最後にインデックス化されたアイテムの識別子です。successfullyIngestedCountは、正常にインデックス化されたアイテムの数です。failedIngestedCountは、インデックス化できなかったアイテムの数です。durationSecondsは、コンテンツ タイプのアイテムのインデックス化に費やされた時間 (秒単位) です。totalCountは、インデックス化するアイテムの総数です。checkpointCreatedTimeは、アイテムのインデックス化が最後に記録された日時 (UTC) です。バックフィル API は、最後にインデックス化されたアイテムを 5 分ごとにチェックします。backfillCompleteがtrueの場合、コンテンツ タイプのすべてのアイテムのインデックス化が完了しています。
系列のバックフィルの場合:
totalCountは、インデックス化する系列関係の総数です。processedCountは、インデックス化された系列関係の数です。lastLineageConnectionは、最後にインデックス化された系列関係です。backfillCompleteがtrueの場合、すべての系列関係のインデックス化が完了しています。
応答例:
要求を実行すると JSON テキストが返されます。JSON を読みやすい形式で表示するには、JSON ビューアーまたはブラウザー アドオンを使用します。
{ "contentBackfillTotalDurationSeconds": 362,
"lineageBackfillTotalDurationSeconds": 14,
"contentBackfillStatuses": [
{
"contentType": "PublishedDatasource",
"contentId": "sites/1/datasources/-631379806-1912815680",
"successfullyIngestedCount": 20,
"failedToIngestCount": 0,
"durationSeconds": 312,
"totalCount": 20,
"checkpointCreatedTime": "2020-07-29T23:50:25.763Z",
"backfillComplete": true
},
{
"contentType": "Database",
"contentId": "sites/1/databases/e1331f9d-4d73-ee04-9edf-96fd1c37cb8e",
"successfullyIngestedCount": 35,
"failedToIngestCount": 0,
"durationSeconds": 26,
"totalCount": 35,
"checkpointCreatedTime": "2020-04-29T23:50:25.769Z",
"backfillComplete": true
},
{
"contentType": "DatabaseTable",
"contentId": "sites/1/tables/d946d084-53a8-09b6-2ad2-93301e6b4b15",
"successfullyIngestedCount": 64,
"failedToIngestCount": 0,
"durationSeconds": 49,
"totalCount": 64,
"checkpointCreatedTime": "2020-04-29T23:50:25.774Z",
"backfillComplete": true
},
{
"contentType": "Metric",
"contentId": "sites/1/metrics/metric1",
"successfullyIngestedCount": 2,
"failedToIngestCount": 0,
"durationSeconds": 254,
"totalCount": 2,
"checkpointCreatedTime": "2020-04-29T23:50:25.779Z",
"backfillComplete": true
},
{
"contentType": "Workbook",
"contentId": "sites/1/workbooks/6749399-1501801290",
"successfullyIngestedCount": 10,
"failedToIngestCount": 0,
"durationSeconds": 267,
"totalCount": 10,
"checkpointCreatedTime": "2020-04-29T23:50:25.784Z",
"backfillComplete": true
},
{
"contentType": "Flow",
"contentId": "sites/1/flows/4",
"successfullyIngestedCount": 4,
"failedToIngestCount": 0,
"durationSeconds": 195,
"totalCount": 4,
"checkpointCreatedTime": "2020-04-29T23:50:25.788Z",
"backfillComplete": true
}
],
"lineageBackfillStatus": {
"totalCount": 45,
"processedCount": 18,
"lastLineageConnection": "CloudFile downstreamWorkbooks Workbook",
"backfillComplete": false
}
}