コネクタステータスの更新（Update connector status）

コネクタステータスAPIの更新

この機能は技術プレビュー中であり、将来のリリースで変更または削除される可能性があります。Elasticは問題を修正するために取り組みますが、技術プレビューの機能は公式GA機能のサポートSLAの対象ではありません。

コネクタのstatusを更新します。

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

リクエスト

PUT _connector/<connector_id>/_status

前提条件

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

パスパラメータ

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

リクエストボディ

• status
• (必須、文字列) コネクタフレームワークで定義された有効なコネクタステータス文字列。

レスポンスコード

• 200
• コネクタstatusフィールドが正常に更新されました。
• 400
• connector_idが提供されていない、リクエストペイロードが不正、または指定されたステータス遷移がサポートされていません。
• 404 (リソースが不足しています)
• connector_idに一致するコネクタが見つかりませんでした。

例

次の例は、IDがmy-connectorのコネクタのstatusを更新します:

Python

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

Ruby

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

Js

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