コネクタ名と説明の更新（Update connector name and description）

コネクタ名と説明APIの更新

この機能はベータ版であり、変更される可能性があります。設計とコードは公式GA機能よりも成熟しておらず、保証なしでそのまま提供されています。ベータ機能は公式GA機能のサポートSLAの対象外です。

コネクタのnameおよびdescriptionフィールドを更新します。

コネクタAPIを始めるには、チュートリアルを確認してください。

リクエスト

PUT _connector/<connector_id>/_name

前提条件

• 自己管理コネクタを使用してデータを同期するには、独自のインフラストラクチャにElasticコネクタサービスをデプロイする必要があります。このサービスは、ネイティブコネクタ用にElastic Cloud上で自動的に実行されます。
• connector_idパラメータは、既存のコネクタを参照する必要があります。

パスパラメータ

• <connector_id>
• (必須、文字列)

リクエストボディ

• name
• (必須、文字列) コネクタの名前。
• description
• (オプション、文字列) コネクタの説明。

レスポンスコード

• 200
• コネクタnameおよびdescriptionフィールドが正常に更新されました。
• 400
• connector_idが提供されていないか、リクエストペイロードが不正です。
• 404 (リソースが不足しています)
• connector_idに一致するコネクタが見つかりませんでした。

例

次の例では、ID my-connectorのコネクタのnameおよびdescriptionフィールドを更新します:

Python

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

Ruby

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

Js

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"
}