コネクタAPIキーIDの更新（Update connector API key id）

コネクタAPIキーID APIの更新

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

コネクタのapi_key_idおよび/またはapi_key_secret_idフィールドを更新し、次のことを指定します：

• 1. 認証に使用されるAPIキーのID
• 2. APIキーが保存されているコネクタシークレットのID

コネクタシークレットIDはネイティブコネクタにのみ必要です。コネクタクライアントはこのフィールドを使用しません。詳細については、ネイティブコネクタAPIキーをプログラムで管理するのドキュメントを参照してください。

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

リクエスト

PUT _connector/<connector_id>/_api_key_id

前提条件

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

パスパラメータ

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

リクエストボディ

• api_key_id
• (オプション、文字列) コネクタが必要なインデックスへのアクセスを認証するために使用するAPIキーのID。各コネクタは、最大1つのAPIキーに関連付けることができます。
• api_key_secret_id
• (オプション、文字列) エンコードされたAPIキーを含むコネクタシークレットのID。これはapi_key_idが参照するのと同じAPIキーである必要があります。これはネイティブコネクタにのみ必要です。

レスポンスコード

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

例

次の例は、IDがmy-connectorのコネクタのapi_key_idおよびapi_key_secret_idフィールドを更新します：

Python

resp = client.connector.update_api_key_id(
   connector_id="my-connector",
   api_key_id="my-api-key-id",
   api_key_secret_id="my-connector-secret-id",
)
print(resp)

Ruby

response = client.connector.update_api_key_id(
  connector_id: 'my-connector',
  body: {
   api_key_id: 'my-api-key-id',
   api_key_secret_id: 'my-connector-secret-id'
  }
)
puts response

Js

const response = await client.connector.updateApiKeyId({
  connector_id: "my-connector",
  api_key_id: "my-api-key-id",
  api_key_secret_id: "my-connector-secret-id",
});
console.log(response);

コンソール

PUT _connector/my-connector/_api_key_id
{
   "api_key_id": "my-api-key-id",
   "api_key_secret_id": "my-connector-secret-id"
}

コンソール-結果

{
   "result": "updated"
}