コネクタ同期ジョブ統計の設定（Set connector sync job stats）

コネクタ同期ジョブ統計APIの設定

この機能は技術プレビュー中であり、将来のリリースで変更または削除される可能性があります。Elasticは問題を修正するために取り組みますが、技術プレビューの機能は公式GA機能のサポートSLAの対象ではありません。

コネクタ同期ジョブの統計を設定します。

コネクタAPIを始めるには、チュートリアルを確認してください。

リクエスト

PUT _connector/_sync_job/<connector_sync_job_id>/_stats

前提条件

• 自己管理型コネクタを使用してデータを同期するには、独自のインフラストラクチャにElasticコネクタサービスをデプロイする必要があります。このサービスは、ネイティブコネクタ用にElastic Cloud上で自動的に実行されます。
• connector_sync_job_idパラメータは、既存のコネクタ同期ジョブを参照する必要があります。

説明

コネクタ同期ジョブの統計を設定します。統計には、deleted_document_count、indexed_document_count、indexed_document_volume、およびtotal_document_countが含まれます。last_seenもこのAPIを使用して更新できます。このAPIは、コネクタサービスが同期ジョブ情報を更新するために主に使用されます。

パスパラメータ

• <connector_sync_job_id>
• (必須、文字列)

リクエストボディ

• deleted_document_count
• (必須、整数) 同期ジョブが削除したドキュメントの数。
• indexed_document_count
• (必須、整数) 同期ジョブがインデックスしたドキュメントの数。
• indexed_document_volume
• (必須、整数) 同期ジョブがインデックスしたデータの総サイズ（MiB単位）。
• total_document_count
• (オプション、整数) 同期ジョブが完了した後のターゲットインデックス内のドキュメントの総数。
• last_seen
• (オプション、瞬時) コネクタ同期ジョブのlast_seenプロパティを設定するためのタイムスタンプ。
• metadata
• (オプション、オブジェクト) コネクタ固有のメタデータ。

レスポンスコード

• 200
• コネクタ同期ジョブの統計が正常に更新されたことを示します。
• 404
• connector_sync_job_idに一致するコネクタ同期ジョブが見つかりませんでした。

例

以下の例は、コネクタ同期ジョブmy-connector-sync-jobのすべての必須およびオプションの統計を設定します:

Python

resp = client.perform_request(
   "PUT",
   "/_connector/_sync_job/my-connector-sync-job/_stats",
   headers={"Content-Type": "application/json"},
   body={
   "deleted_document_count": 10,
   "indexed_document_count": 20,
   "indexed_document_volume": 1000,
   "total_document_count": 2000,
   "last_seen": "2023-01-02T10:00:00Z"
   },
)
print(resp)

Ruby

response = client.connector.sync_job_update_stats(
  connector_sync_job_id: 'my-connector-sync-job',
  body: {
   deleted_document_count: 10,
   indexed_document_count: 20,
   indexed_document_volume: 1000,
   total_document_count: 2000,
   last_seen: '2023-01-02T10:00:00Z'
  }
)
puts response

Js

const response = await client.transport.request({
  method: "PUT",
  path: "/_connector/_sync_job/my-connector-sync-job/_stats",
  body: {
   deleted_document_count: 10,
   indexed_document_count: 20,
   indexed_document_volume: 1000,
   total_document_count: 2000,
   last_seen: "2023-01-02T10:00:00Z",
  },
});
console.log(response);

コンソール

PUT _connector/_sync_job/my-connector-sync-job/_stats
{
   "deleted_document_count": 10,
   "indexed_document_count": 20,
   "indexed_document_volume": 1000,
   "total_document_count": 2000,
   "last_seen": "2023-01-02T10:00:00Z"
}