コネクタ同期ジョブの一覧（List connector sync jobs）

コネクタ同期ジョブのリストAPI

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

作成日順に昇順で並べられたすべての保存されたコネクタ同期ジョブに関する情報を返します。

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

リクエスト

GET _connector/_sync_job

前提条件

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

パスパラメータ

• size
• （オプション、整数）取得する結果の最大数。デフォルトは 100 です。
• from
• （オプション、整数）最初の結果から取得するオフセット。デフォルトは 0 です。
• status
• （オプション、ジョブステータス）結果をフィルタリングするためのカンマ区切りのジョブステータスのリスト。利用可能なステータスには、canceling、canceled、completed、error、in_progress、pending、suspended が含まれます。
• connector_id
• （オプション、文字列）取得した同期ジョブが持つ必要のあるコネクタID。
• job_type
• （オプション、ジョンタイプ）カンマ区切りのジョブタイプのリスト。利用可能なジョブタイプは、full、incremental、access_control です。

例

次の例は、すべてのコネクタ同期ジョブをリストします:

Python

resp = client.perform_request(
   "GET",
   "/_connector/_sync_job",
)
print(resp)

Ruby

response = client.connector.sync_job_list
puts response

Js

const response = await client.transport.request({
  method: "GET",
  path: "/_connector/_sync_job",
});
console.log(response);

コンソール

GET _connector/_sync_job

次の例は、最初の2つのコネクタ同期ジョブをリストします:

Python

resp = client.perform_request(
   "GET",
   "/_connector/_sync_job",
   params={
   "from": "0",
   "size": "2"
   },
)
print(resp)

Ruby

response = client.connector.sync_job_list(
  from: 0,
  size: 2
)
puts response

Js

const response = await client.transport.request({
  method: "GET",
  path: "/_connector/_sync_job",
  querystring: {
   from: "0",
   size: "2",
  },
});
console.log(response);

コンソール

GET _connector/_sync_job?from=0&size=2

次の例は、保留中のコネクタ同期ジョブをリストします（デフォルトで最初の100件）：

Python

resp = client.perform_request(
   "GET",
   "/_connector/_sync_job",
   params={
   "status": "pending"
   },
)
print(resp)

Ruby

response = client.connector.sync_job_list(
  status: 'pending'
)
puts response

Js

const response = await client.transport.request({
  method: "GET",
  path: "/_connector/_sync_job",
  querystring: {
   status: "pending",
  },
});
console.log(response);

コンソール

GET _connector/_sync_job?status=pending

次の例は、コネクタID connector-1 のコネクタ同期ジョブをリストします（デフォルトで最初の100件）：

Python

resp = client.perform_request(
   "GET",
   "/_connector/_sync_job",
   params={
   "connector_id": "connector-1"
   },
)
print(resp)

Ruby

response = client.connector.sync_job_list(
  connector_id: 'connector-1'
)
puts response

Js

const response = await client.transport.request({
  method: "GET",
  path: "/_connector/_sync_job",
  querystring: {
   connector_id: "connector-1",
  },
});
console.log(response);

コンソール

GET _connector/_sync_job?connector_id=connector-1

次の例は、ジョブタイプ full または incremental のコネクタ同期ジョブをリストします（デフォルトで最初の100件）：

Python

resp = client.perform_request(
   "GET",
   "/_connector/_sync_job",
   params={
   "job_type": "full,incremental"
   },
)
print(resp)

Ruby

response = client.connector.sync_job_list(
  job_type: 'full,incremental'
)
puts response

Js

const response = await client.transport.request({
  method: "GET",
  path: "/_connector/_sync_job",
  querystring: {
   job_type: "full,incremental",
  },
});
console.log(response);

コンソール

GET _connector/_sync_job?job_type=full,incremental

レスポンスコード

200: 結果が正常に返されたことを示します（結果は空でもかまいません）。

400: リクエストが不正であることを示します。