コネクタ同期ジョブAPIの作成

この機能はベータ版であり、変更される可能性があります。設計とコードは公式GA機能よりも成熟しておらず、保証なしでそのまま提供されています。ベータ機能は公式GA機能のサポートSLAの対象外です。

コネクタ同期ジョブを作成します。

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

Python

  1. resp = client.perform_request(
  2.    "POST",
  3.    "/_connector/_sync_job",
  4.    headers={"Content-Type": "application/json"},
  5.    body={
  6.    "id": "connector-id",
  7.    "job_type": "full",
  8.    "trigger_method": "on_demand"
  9.    },
  10. )
  11. print(resp)

Ruby

  1. response = client.connector.sync_job_post(
  2.   body: {
  3.    id: 'connector-id',
  4.    job_type: 'full',
  5.    trigger_method: 'on_demand'
  6.   }
  7. )
  8. puts response

Js

  1. const response = await client.transport.request({
  2.   method: "POST",
  3.   path: "/_connector/_sync_job",
  4.   body: {
  5.    id: "connector-id",
  6.    job_type: "full",
  7.    trigger_method: "on_demand",
  8.   },
  9. });
  10. console.log(response);

コンソール

  1. POST _connector/_sync_job
  2. {
  3.   "id": "connector-id",
  4.   "job_type": "full",
  5.   "trigger_method": "on_demand"
  6. }

リクエスト

POST _connector/_sync_job

前提条件

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

説明

内部インデックスにコネクタ同期ジョブドキュメントを作成し、そのカウンタとタイムスタンプをデフォルト値で初期化します。特定の値はAPIを介して更新できます。

リクエストボディ

  • id
  • (必須、文字列) 同期ジョブを作成するためのコネクタのID。
  • job_type
  • (オプション、文字列) 作成された同期ジョブのジョブタイプ。デフォルトはfullです。
  • trigger_method
  • (オプション、文字列) 作成された同期ジョブのトリガーメソッド。デフォルトはon_demandです。

レスポンスボディ

  • id
  • (文字列) コネクタ同期ジョブドキュメントに関連付けられたID。

レスポンスコード

  • 201
  • コネクタ同期ジョブが正常に作成されたことを示します。
  • 400
  • リクエストが不正であることを示します。
  • 404
  • インデックスまたは参照されたコネクタが欠落していることを示します。