コネクタ同期ジョブのキャンセル（Cancel connector sync job）

コネクタ同期ジョブのキャンセルAPI

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

コネクタ同期ジョブをキャンセルします。

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

リクエスト

PUT _connector/_sync_job/<connector_sync_job_id>/_cancel

前提条件

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

説明

コネクタ同期ジョブをキャンセルし、statusをcancellingに設定し、cancellation_requested_atを現在の時間に更新します。その後、コネクタサービスはコネクタ同期ジョブのstatusをcancelledに設定する責任を負います。

パスパラメータ

• connector_sync_job_id
• （必須、文字列）

レスポンスコード

• 200
• コネクタ同期ジョブのキャンセルが正常にリクエストされました。
• 404
• connector_sync_job_idに一致するコネクタ同期ジョブが見つかりませんでした。

例

以下の例は、IDがmy-connector-sync-job-idのコネクタ同期ジョブをキャンセルします:

Python

resp = client.perform_request(
   "PUT",
   "/_connector/_sync_job/my-connector-sync-job-id/_cancel",
)
print(resp)

Ruby

response = client.connector.sync_job_cancel(
  connector_sync_job_id: 'my-connector-sync-job-id'
)
puts response

Js

const response = await client.transport.request({
  method: "PUT",
  path: "/_connector/_sync_job/my-connector-sync-job-id/_cancel",
});
console.log(response);

コンソール

PUT _connector/_sync_job/my-connector-sync-job-id/_cancel