› › ›

API списка соединителей

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

Возвращает информацию обо всех созданных соединителях.

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

Запрос

GET _connector

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

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

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

size: (Необязательно, целое число) Максимальное количество результатов для извлечения. По умолчанию 100.
from: (Необязательно, целое число) Смещение от первого результата для извлечения. По умолчанию 0.
index_name: (Необязательно, строка) Список имён индексов, связанных с соединителями, используемый для фильтрации результатов поиска, разделенные запятыми.
connector_name: (Необязательно, строка) Список имён соединителей, используемый для фильтрации результатов поиска, разделенные запятыми.
service_type: (Необязательно, строка) Список типов служб соединителей, используемый для фильтрации результатов поиска, разделенные запятыми.

Примеры

Следующий пример выводит список всех соединителей:

resp = client.connector.list()
print(resp)

response = client.connector.list
puts response

const response = await client.connector.list();
console.log(response);

GET _connector

Следующий пример выводит первые два соединителя:

resp = client.connector.list(
    from_="0",
    size="2",
)
print(resp)

const response = await client.connector.list({
  from: 0,
  size: 2,
});
console.log(response);

GET _connector?from=0&size=2

Пример вывода соединителя, связанного с индексом Elasticsearch search-google-drive:

resp = client.connector.list(
    index_name="search-google-drive",
)
print(resp)

const response = await client.connector.list({
  index_name: "search-google-drive",
});
console.log(response);

GET _connector?index_name=search-google-drive

Пример вывода всех соединителей с типом службы sharepoint_online:

resp = client.connector.list(
    service_type="sharepoint_online",
)
print(resp)

const response = await client.connector.list({
  service_type: "sharepoint_online",
});
console.log(response);

GET _connector?service_type=sharepoint_online

Пример вывода всех соединителей с типом службы sharepoint_online или google_drive:

resp = client.connector.list(
    service_type="sharepoint_online,google_drive",
)
print(resp)

const response = await client.connector.list({
  service_type: "sharepoint_online,google_drive",
});
console.log(response);

GET _connector?service_type=sharepoint_online,google_drive

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