› › ›

API обновления статуса подключения

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

Обновляет состояние подключения.

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

Запрос

PUT _connector/<connector_id>/_status

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

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

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

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

Тело запроса

status: (Обязательно, строка) Допустимое значение статуса подключения, определенное в Connector Framework.

Коды ответов

200: Поле статуса подключения status было успешно обновлено.
400: Параметр connector_id не был предоставлен, тело запроса неверно сформировано или данный переход состояния не поддерживается.
404 (Отсутствующие ресурсы): Не найдено подключения, соответствующего connector_id.

Примеры

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

resp = client.connector.update_status(
    connector_id="my-connector",
    status="needs_configuration",
)
print(resp)

response = client.connector.update_status(
  connector_id: 'my-connector',
  body: {
    status: 'needs_configuration'
  }
)
puts response

const response = await client.connector.updateStatus({
  connector_id: "my-connector",
  status: "needs_configuration",
});
console.log(response);

PUT _connector/my-connector/_status
{
    "status": "needs_configuration"
}

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