› › ›

API обновления конфигурации коннекторов

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

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

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

Запрос

PUT _connector/<connector_id>/_configuration

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

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

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

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

Тело запроса

values: (Необязательно, объект) Значения конфигурации для коннектора, представленные в виде сопоставления полей конфигурации с их соответствующими значениями в зарегистрированной схеме.
configuration: (Необязательно, объект) Определение схемы конфигурации для коннектора. Поле конфигурации представляет собой карту, где каждый ключ обозначает имя конкретного поля конфигурации, а значение является ConnectorConfiguration объектом. Для управления коннекторами используйте values для передачи значений конфигурации. configuration объект используется службой Elastic Connector Service для регистрации схемы конфигурации коннектора.

Коды ответов

200: Конфигурация коннектора была успешно обновлена.
400: connector_id не был предоставлен или тело запроса имело неправильный формат.
404 (Отсутствующие ресурсы): Коннектор, соответствующий connector_id, не найден.

Примеры

В следующем примере настраивается коннектор sharepoint_online. Поддерживаемые параметры конфигурации можно найти в документации коннектора SharePoint Online или, просмотрев схему в поле configuration коннектора с помощью API получения коннектора.

resp = client.connector.update_configuration(
    connector_id="my-spo-connector",
    values={
        "tenant_id": "my-tenant-id",
        "tenant_name": "my-sharepoint-site",
        "client_id": "foo",
        "secret_value": "bar",
        "site_collections": "*"
    },
)
print(resp)

const response = await client.connector.updateConfiguration({
  connector_id: "my-spo-connector",
  values: {
    tenant_id: "my-tenant-id",
    tenant_name: "my-sharepoint-site",
    client_id: "foo",
    secret_value: "bar",
    site_collections: "*",
  },
});
console.log(response);

PUT _connector/my-spo-connector/_configuration
{
    "values": {
        "tenant_id": "my-tenant-id",
        "tenant_name": "my-sharepoint-site",
        "client_id": "foo",
        "secret_value": "bar",
        "site_collections": "*"
    }
}

{
    "result": "updated"
}

При первом настройке коннектора необходимо указать все необходимые детали конфигурации для запуска синхронизации. Но вы также можете использовать этот API для обновления только подмножества полей. Вот пример, который обновляет только поле secret_value для коннектора sharepoint_online. Другие значения конфигурации не изменятся.

resp = client.connector.update_configuration(
    connector_id="my-spo-connector",
    values={
        "secret_value": "foo-bar"
    },
)
print(resp)

const response = await client.connector.updateConfiguration({
  connector_id: "my-spo-connector",
  values: {
    secret_value: "foo-bar",
  },
});
console.log(response);

PUT _connector/my-spo-connector/_configuration
{
    "values": {
        "secret_value": "foo-bar"
    }
}

{
    "result": "updated"
}

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