› › ›

API создания соединителей

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

Создаёт соединитель Elasticsearch. Соединители — это интеграции с Elasticsearch, которые переносят контент из сторонних источников данных, которые могут быть развернуты в Elastic Cloud или на вашей собственной инфраструктуре:

Управляемые соединители — это управляемая служба в Elastic Cloud
Самостоятельно управляемые соединители — это самохостинг на вашей инфраструктуре

Список всех поддерживаемых типов служб вы найдёте в документации по соединителям.

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

resp = client.connector.put(
    connector_id="my-connector",
    index_name="search-google-drive",
    name="My Connector",
    service_type="google_drive",
)
print(resp)

response = client.connector.put(
  connector_id: 'my-connector',
  body: {
    index_name: 'search-google-drive',
    name: 'My Connector',
    service_type: 'google_drive'
  }
)
puts response

const response = await client.connector.put({
  connector_id: "my-connector",
  index_name: "search-google-drive",
  name: "My Connector",
  service_type: "google_drive",
});
console.log(response);

PUT _connector/my-connector
{
  "index_name": "search-google-drive",
  "name": "My Connector",
  "service_type": "google_drive"
}

Запрос

POST _connector
PUT _connector/<connector_id>

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

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

Описание

Создаёт документ соединителя во внутреннем индексе и инициализирует его конфигурацию, фильтрацию и планирование с использованием значений по умолчанию. Эти значения могут быть обновлены по мере необходимости.

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

<connector_id>: (Необязательно, строка) Уникальный идентификатор соединителя.

Тело запроса

description: (Необязательно, строка) Описание соединителя.
index_name: (Необязательно, строка) Целевой индекс для синхронизации данных. Если индекс не существует, он будет создан при первой синхронизации.
name: (Необязательно, строка) Название соединителя. Рекомендуется указывать имя соединителя для управления соединителями в Kibana.
is_native: (Необязательно, логическое значение) Указывает, является ли это управляемым соединителем. По умолчанию false.
language: (Необязательно, строка) Анализатор языка для данных. Ограничен поддерживаемыми языками.
service_type: (Необязательно, строка) Тип службы соединителя. Может ссылаться на поддерживаемые Elasticsearch сторонние службы или на пользовательский тип соединителя. Ознакомьтесь с доступными типами служб для управляемых и самостоятельно управляемых соединителей.

Тело ответа

id: (строка) Идентификатор, связанный с документом соединителя. Возвращается при использовании запроса POST.
result: (строка) Результат операции индексирования, created или updated. Возвращается при использовании запроса PUT.

Коды ответов

200: Указывает, что существующий соединитель был успешно обновлён.
201: Указывает, что соединитель был успешно создан.
400: Указывает, что запрос был некорректным.

Примеры

resp = client.connector.put(
    connector_id="my-connector",
    index_name="search-google-drive",
    name="My Connector",
    description="My Connector to sync data to Elastic index from Google Drive",
    service_type="google_drive",
    language="en",
)
print(resp)

const response = await client.connector.put({
  connector_id: "my-connector",
  index_name: "search-google-drive",
  name: "My Connector",
  description: "My Connector to sync data to Elastic index from Google Drive",
  service_type: "google_drive",
  language: "en",
});
console.log(response);

PUT _connector/my-connector
{
  "index_name": "search-google-drive",
  "name": "My Connector",
  "description": "My Connector to sync data to Elastic index from Google Drive",
  "service_type": "google_drive",
  "language": "en"
}

API возвращает следующий результат:

{
  "result": "created",
  "id": "my-connector"
}

© 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-api.html