API キーの管理 - OpenSearch - Alibaba Cloud ドキュメントセンター

OpenSearch LLM-Based Conversational Search エディションへの API および SDK 呼び出しには、認証または認可が必要です。このトピックでは、認証と認可の方法、および API キーの管理方法について解説します。

API 呼び出しの認証

API キーを使用して API 呼び出しを認証できます。この方法では、リクエストに API キーを含める必要があります。各インスタンスにつき、最大 10 個の API キーを作成し、有効化できます。

重要

API キーの漏洩を防ぐには：

API キーを公開しないでください。不正利用は、セキュリティリスクや金銭的損失につながる可能性があります。
API 呼び出しは、サーバー側からのみ開始してください。ブラウザ、アプリ、またはミニプログラムなどからのクライアント側の API 呼び出しは、API キーの漏洩につながる可能性があります。
API キーが漏洩した疑いがある場合は、OpenSearch コンソールにサインインして、まずキーを無効化してから削除してください。無効化された API キーは、API 呼び出しに使用できなくなります。

API 呼び出しの認可

AccessKey を使用して API 呼び出しを認可できます。AccessKey は Alibaba Cloud が提供する長期的な認証情報です。これは、AccessKey ID と AccessKey Secret からなるキーペアです。

AccessKey はコンソールへのサインインには使用されません。代わりに、API、CLI、SDK、Terraform などの開発ツールを介して Alibaba Cloud にアクセスするために使用されます。これらのツールは、AccessKey ID と AccessKey Secret を使用してリクエストに署名し、送信者の身元とリクエストの完全性を検証します。

API アクセス専用の RAM ユーザーを作成し、対応する AccessKey を作成して、必要最小限の権限のみを付与することを強く推奨します。詳細については、「AccessKey の作成」および「RAM ユーザーの作成と権限の付与」をご参照ください。

手順

OpenSearch コンソールにサインインします。
目的のリージョンを選択し、[OpenSearch LLM-Based Conversational Search Edition] に切り替えます。
インスタンスリストで、目的のインスタンスの右側にある管理をクリックします。左側のナビゲーションペインで、API キーの管理 をクリックします。
API Key の作成 をクリックします。これにより API キーが生成されます。[コピー] をクリックして API キーを保存するか、CSV ファイルをダウンロードして API キー情報を保存します。
API キーを安全に保存した後、API キーを保存した を選択し、OK をクリックしてダイアログボックスを閉じます。
- [編集]：API キーに説明を追加します。
- [表示]：API キーを表示します。
- [無効化]/[有効化]：API キーを有効化または無効化します。無効化されたキーは API 呼び出しに使用できません。
- [削除]：無効化された API キーのみ削除できます。

例：API キー認証

次の例は、API キーを使用してエントリ一覧を取得する curl リクエストを示しています。この例を実行するには、URL を更新し、プレースホルダーをお客様の API キーに置き換えてください。

curl --location 'http://***.opensearch-ap-northeast-1.aliyuncs.com/v3/openapi/apps/[app_group_identity]/knowledge/entries' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json'

サンプルレスポンス：

{
  "request_id":"4F6F9BDC-740F-4FC1-B976-74CAFCBF1333",
  "status":"OK",
  "total_count":2,
  "latency":0.0,
  "result":[
    {
      "entry_id":"ca0c8c1cec7c41a280c76c16f0db79f6",
      "create_time":1718188424000,
      "update_time":1718188424000,
      "questions":[
          "東京でマイナンバーカードを受け取る際の窓口はどこですか？"
      ],
      "answer":"「こんにちは。受け取り窓口は〇〇区役所です。電話番号は 03-XXXX-XXXX です。」"
      },
    {
      "entry_id":"2f4c7350a7104f029f316706b61b6eb2",
      "create_time":1718193627000,
      "update_time":1718193627000,
      "questions":[
          "会社の登記変更は代理人でも申請できますか？"
      ],
      "answer":"はい、代理人による申請が可能です。必要な書類を窓口にご提出ください。委任状には本人の署名が必要です。"
    }
    ],
    "errors":[]
}