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

OpenSearch LLM-Based Conversational Search Edition のサービスを API または SDK を通じて呼び出すには、呼び出し元の ID を認証または認可する必要があります。このトピックでは、認証と認可の方法、および API キーの管理方法について説明します。

API 呼び出しの認証

API キーによる API 呼び出しの認証：これは OpenSearch LLM-Based Conversational Search Edition が提供する認証方法です。この方法で API を呼び出す場合、アクセスキー、つまり API キーを提供する必要があります。インスタンスごとに最大 10 個の API キーを作成し、有効化できます。

重要

API キーの漏洩を防ぐために：

不正使用によるセキュリティリスクや経済的損失を避けるため、API キーはいかなる方法でも公開しないでください。

API 呼び出しはサーバー側からのみ開始する必要があります。ブラウザ、アプリ、ミニプログラムなどのクライアント側から開始される API 呼び出しは、API キーの漏洩を引き起こす可能性があります。
API キーが漏洩した疑いがある場合は、OpenSearch LLM-Based Conversational Search Edition にログインして、まず API キーを無効化してから削除できます。API キーを無効化すると、そのキーでは API 呼び出しを行えなくなります。

API 呼び出しの認可

AccessKey ペア (AK) による API 呼び出しの認可：これは Alibaba Cloud が提供する永続的なアクセス認証情報であり、AccessKey ID と AccessKey Secret で構成されます。

AccessKey ペアは、コンソールへのログインには使用されません。代わりに、開発ツール (API、CLI、SDK、Terraform など) を通じて Alibaba Cloud にアクセスするために使用されます。リクエストには、AccessKey ID と AccessKey Secret でリクエスト内容を暗号化して生成された署名が含まれており、この署名を使用してお客様の ID とリクエストの有効性を検証します。

API アクセス専用の RAM ユーザーを作成し、対応する AccessKey ペアを生成し、最小権限の原則に基づいて権限を付与した上で、API を通じて開発ワークベンチサービスを呼び出すことを強く推奨します。詳細については、「RAM ユーザーの作成と権限付与」をご参照ください。

操作手順

OpenSearch コンソールにログインします。
対象リージョンを選択し、OpenSearch LLM-Based Conversational Search Edition に切り替えます。
インスタンス一覧で、対象インスタンスの右側にある管理をクリックし、左側のナビゲーションペインでAPI キーの管理を選択します。
API キーの作成 をクリックします。システムが API キーを生成します。[コピー] をクリックして API キーを保存するか、CSV ファイルをダウンロードして API キー情報を保存します。
API キーを安全に保存したら、API キーを保存した をクリックし、次に OK をクリックしてダイアログを閉じます。
- [編集]：API キーに説明を追加します。
- [表示]：API キーを表示します。
- [無効化]/[有効化]：API キーを無効化すると API 呼び出しに使用できなくなります。有効化すると使用できるようになります。
- [削除]：API キーが無効な場合に削除できます。

API キー認証の例

API キーを使用して呼び出しを認証することもできます。以下は、API キー認証を使用してエントリのリストを取得する curl リクエストの例です。URL と API キーを設定した後、テストを実行できます。

curl --location 'http://***.opensearch-cn-shanghai.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":"「こんにちは、窓口の住所は****、電話番号は0571-12329-1です」"
      },
    {
      "entry_id":"2f4c7350a7104f029f316706b61b6eb2",
      "create_time":1718193627000,
      "update_time":1718193627000,
      "questions":[
          "国内資本の支店の登録抹消申請を代理で手続きできますか"
      ],
      "answer":"「はい、代理での手続きは可能です。窓口で書類を提出する際、委任状*****と代理人の署名が必要です。」"
    }
    ],
    "errors":[]
}