› › ›

API обновления имени и описания коннектора

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

Обновляет поля name и description коннектора.

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

Запрос

PUT _connector/<connector_id>/_name

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

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

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

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

Тело запроса

name: (Обязательно, строка) Название коннектора.
description: (Необязательно, строка) Описание коннектора.

Коды ответов

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

Примеры

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

resp = client.connector.update_name(
    connector_id="my-connector",
    name="Custom connector",
    description="This is my customized connector",
)
print(resp)

response = client.connector.update_name(
  connector_id: 'my-connector',
  body: {
    name: 'Custom connector',
    description: 'This is my customized connector'
  }
)
puts response

const response = await client.connector.updateName({
  connector_id: "my-connector",
  name: "Custom connector",
  description: "This is my customized connector",
});
console.log(response);

PUT _connector/my-connector/_name
{
    "name": "Custom connector",
    "description": "This is my customized connector"
}

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