› › ›

API отмены задачи синхронизации подключения

Данная функциональность находится в стадии бета-тестирования и может быть изменена. Дизайн и код менее отлажены, чем официальные функции GA, и предоставляются как есть без гарантий. Для бета-функций не действует SLA поддержки, предусмотренный для официальных функций GA.

Отменяет задачу синхронизации подключения.

Чтобы начать работу с API подключений, ознакомьтесь с нашим руководством.

Запрос

PUT _connector/_sync_job/<connector_sync_job_id>/_cancel

Предварительные условия

Для синхронизации данных с помощью собственных подключений, вам необходимо развернуть сервис подключения Elastic на вашей инфраструктуре. Этот сервис работает автоматически в Elastic Cloud для управляемых Elastic подключений.
Параметр connector_sync_job_id должен ссылаться на существующую задачу синхронизации подключения.

Описание

Отменяет задачу синхронизации подключения, что устанавливает status в значение cancelling и обновляет cancellation_requested_at до текущего времени. Затем служба подключения отвечает за установку status задач синхронизации подключения в значение cancelled.

Параметры пути

connector_sync_job_id: (Обязательно, строка)

Коды ответов

200: Запрос на отмену задачи синхронизации подключения был успешно выполнен.
404: Не найдена задача синхронизации подключения, соответствующая значению connector_sync_job_id.

Примеры

Следующий пример отменяет задачу синхронизации подключения с идентификатором my-connector-sync-job-id:

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

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

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

© 2023-2025 Elasticsearch
As of September 2024, Elasticsearch is available under a choice of three licenses: the Server Side Public License (SSPL), the Elastic License, or the AGPLv3 (OSI approved).
Elasticsearch and the Elasticsearch logo are trademarks of Elasticsearch B.V., registered in the U.S. and in other countries.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/cancel-connector-sync-job-api.html