› › ›

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

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

Управляет функциями коннектора. Этот конечный пункт может использоваться для управления следующими аспектами коннектора:

Безопасность на уровне документов
Инкрементные синхронизации
Расширенные правила синхронизации
Базовые правила синхронизации

Обычно работающий сервис коннектора автоматически управляет этими функциями. Однако вы можете использовать этот API для переопределения стандартного поведения.

Для начала работы с Connector APIs ознакомьтесь с нашим руководством.

Запрос

PUT _connector/<connector_id>/_features

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

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

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

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

Тело запроса

features

(Обязательно, объект) Объект, содержащий функции коннектора.

document_level_security (Необязательно, объект) Управляет включением безопасности на уровне документов с флагом enabled.
incremental_sync (Необязательно, объект) Управляет включением инкрементных синхронизаций с флагом enabled.
native_connector_api_keys (Необязательно, объект) Управляет включением управляемых API-ключей коннектора с флагом enabled.
sync_rules (Необязательно, объект) Управляет правилами синхронизации.
- advanced (Необязательно, объект) Управляет включением расширенных правил синхронизации с флагом enabled.
- basic (Необязательно, объект) Управляет включением базовых правил синхронизации с флагом enabled.

Коды ответов

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

Примеры

В следующем примере обновляется поле features для коннектора с идентификатором my-connector:

resp = client.perform_request(
    "PUT",
    "/_connector/my-connector/_features",
    headers={"Content-Type": "application/json"},
    body={
        "features": {
            "document_level_security": {
                "enabled": True
            },
            "incremental_sync": {
                "enabled": True
            },
            "sync_rules": {
                "advanced": {
                    "enabled": False
                },
                "basic": {
                    "enabled": True
                }
            }
        }
    },
)
print(resp)

const response = await client.transport.request({
  method: "PUT",
  path: "/_connector/my-connector/_features",
  body: {
    features: {
      document_level_security: {
        enabled: true,
      },
      incremental_sync: {
        enabled: true,
      },
      sync_rules: {
        advanced: {
          enabled: false,
        },
        basic: {
          enabled: true,
        },
      },
    },
  },
});
console.log(response);

PUT _connector/my-connector/_features
{
  "features": {
    "document_level_security": {
      "enabled": true
    },
    "incremental_sync": {
      "enabled": true
    },
    "sync_rules": {
      "advanced": {
        "enabled": false
      },
      "basic": {
        "enabled": true
      }
    }
  }
}

{
    "result": "updated"
}

Конечный пункт поддерживает частичное обновление поля features. Например, для обновления только функции document_level_security можно отправить следующий запрос:

resp = client.perform_request(
    "PUT",
    "/_connector/my-connector/_features",
    headers={"Content-Type": "application/json"},
    body={
        "features": {
            "document_level_security": {
                "enabled": True
            }
        }
    },
)
print(resp)

const response = await client.transport.request({
  method: "PUT",
  path: "/_connector/my-connector/_features",
  body: {
    features: {
      document_level_security: {
        enabled: true,
      },
    },
  },
});
console.log(response);

PUT _connector/my-connector/_features
{
  "features": {
    "document_level_security": {
      "enabled": true
    }
  }
}

{
    "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-features-api.html