Spec-Zone.ru › Elasticsearch 8
›Elasticsearch Руководство [8.17] ›REST API ›API коннекторов

API создания задачи синхронизации коннектора

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

Новая справка по API

Для получения самой актуальной информации об API, обратитесь к API коннекторов.

Создает задачу синхронизации коннектора.

Для начала работы с API коннекторов, ознакомьтесь с нашим пособием.

resp = client.perform_request(
    "POST",
    "/_connector/_sync_job",
    headers={"Content-Type": "application/json"},
    body={
        "id": "connector-id",
        "job_type": "full",
        "trigger_method": "on_demand"
    },
)
print(resp)
response = client.connector.sync_job_post(
  body: {
    id: 'connector-id',
    job_type: 'full',
    trigger_method: 'on_demand'
  }
)
puts response
const response = await client.transport.request({
  method: "POST",
  path: "/_connector/_sync_job",
  body: {
    id: "connector-id",
    job_type: "full",
    trigger_method: "on_demand",
  },
});
console.log(response);
POST _connector/_sync_job
{
  "id": "connector-id",
  "job_type": "full",
  "trigger_method": "on_demand"
}

Запрос

POST _connector/_sync_job

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

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

Описание

Создает документ задачи синхронизации коннектора во внутреннем индексе и инициализирует его счетчики и метки времени значениями по умолчанию. Некоторые значения можно обновить через API.

Тело запроса

id
(Обязательно, строка) Идентификатор коннектора, для которого создается задача синхронизации.
job_type
(Необязательно, строка) Тип задачи создаваемой задачи синхронизации. По умолчанию full.
trigger_method
(Необязательно, строка) Способ запуска создаваемой задачи синхронизации. По умолчанию on_demand.

Тело ответа

id
(строка) Идентификатор, связанный с документом задачи синхронизации коннектора.

Коды ответов

201
Указывает, что задача синхронизации коннектора была успешно создана.
400
Указывает, что запрос имеет неправильный формат.
404
Указывает, что индекс или указанный коннектор отсутствуют.

© 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/create-connector-sync-job-api.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API