介紹如何管理API Key - OpenSearch

通過API/SDK調用OpenSearch-LLM智能問答版服務時，需要對調用者身份進行認證或者鑒權，本文介紹身份認證和鑒權的方式及如何管理API Key。

API調用認證

通過API Key實現API調用認證：是-LLM智能問答版提供的認證方式，通過該方式調用API時，需提供存取金鑰即API Key。一個執行個體下最多允許建立和啟用10個API Key。

重要

為保障API Key不被泄露：

不要將API Key以任何方式公開，避免因未經授權的使用造成安全風險或資金損失。

API調用應僅發起於服務端，任何發起自用戶端的API調用，例如瀏覽器、App或小程式等，均有可能造成API Key的泄露。
如API Key疑似泄露，您可以登入OpenSearch-LLM智能問答版先禁用再刪除該API Key。API Key被禁用後，無法通過該API Key進行API調用。

API調用鑒權

通過AccessKey（簡稱AK）實現API調用鑒權：是阿里雲提供給使用者的永久訪問憑據，一組由AccessKey ID和AccessKey Secret組成的金鑰組。

AK不用於控制台登入，而是用於通過開發工具（API、CLI、SDK、Terraform等）訪問阿里雲時，發起的請求會攜帶AccessKey ID和AccessKey Secret加密請求內容產生的簽名，進行身分識別驗證及請求合法性校正。

強烈建議您建立專用於API訪問的RAM使用者並建立對應的AK，完成最小化授權後，通過API調用開發工作台服務。請參見建立RAM使用者並授權。

操作步驟

登入OpenSearch控制台。
選擇目標地區，切換到OpenSearch-LLM智能問答版。
在執行個體列表單擊目標執行個體右側的管理，選擇左側導覽列API Keys。
單擊建立API Key，系統產生一個API Key，單擊複製儲存API Key或者下載CSV檔案儲存API Key資訊。
安全儲存API Key後，單擊我已儲存好 API Key，單擊確定關閉彈窗。
- 編輯：為API Key添加描述備忘資訊。
- 查看：查看API Key。
- 禁用/啟用：禁用狀態時，無法通過該API Key進行API調用；啟用狀態時，可以通過該API Key進行API調用。
- 刪除：禁用狀態時，可以刪除該API Key。

API Key認證樣本

您也可以使用API Key的方式完成調用認證，下面是一個使用API Key認證的擷取詞條列表的curl請求樣本，您配置完URL與API Key後可進行測試。

curl --location 'http://***.opensearch-cn-shanghai.aliyuncs.com/v3/openapi/apps/[app_group_identity]/knowledge/entries' \
--header 'Authorization: Bearer 您的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":[]
}