Table Store支援使用 API Key 或 AccessKey 訪問知識儲存服務和記憶儲存服務。API Key 無需管理 AccessKey 金鑰組,支援獨立建立和吊銷,適合 AI 應用快速接入。本文主要介紹 API Key 的建立和使用方法。
選擇認證方式
請根據應用需要訪問的資源選擇認證方式。
認證方式 | 適用情境 | 支援範圍 | 使用說明 |
API Key | 應用只需調用知識儲存服務和記憶儲存服務的 API | 知識儲存服務和記憶儲存服務的全部 API | 接入簡單,必須使用 HTTPS,不支援訪問 OSS 或Table Store的其他 API |
AccessKey(AK/SK) | 應用還需訪問 OSS、Table Store其他能力,或需要通過 RAM Policy 精細控制許可權 | 由 RAM 身份獲得的許可權決定 | 生產環境建議使用 RAM 使用者的 AccessKey 或 STS 臨時訪問憑證,不要使用阿里雲帳號 AccessKey |
如果只調用知識儲存和記憶儲存介面,建議使用 API Key。如果需要將本地檔案上傳至 OSS 後匯入知識庫,或者訪問Table Store的其他介面,請使用 AccessKey 或 STS 臨時訪問憑證。AccessKey 的建立、授權和 RAM Policy 配置方法,請參見配置存取權限。
建立 API Key
在左側導覽列,單擊API Key。
在 API Key 管理頁面,單擊建立 API Key。
在建立 API Key 對話方塊,設定到期時間。
單擊建立。
請妥善保管密鑰值,僅在建立時顯示一次,無法再次查看。
使用 API Key
通過 SDK 或 curl 使用 API Key 訪問知識儲存服務和記憶儲存服務。API Key 支援兩項服務的全部 API 操作,包括建立、查詢、檢索和刪除。
通過 API Key 訪問時,必須使用 HTTPS 協議的訪問地址。
Python
需安裝AgentStorage Python SDK :pip install tablestore-agent-storagefrom tablestore_agent_storage import AgentStorageClient
# 使用 API Key 初始化用戶端
client = AgentStorageClient(
api_key="your-api-key",
ots_endpoint="https://your-instance.cn-beijing.ots.aliyuncs.com",
ots_instance_name="your-instance-name",
)
# 建立知識庫
client.create_knowledge_base({"knowledgeBaseName": "product_docs"})
# 查看已建立的知識庫
response = client.list_knowledge_base()
for kb in response["data"]["knowledgeBases"]:
print(kb["knowledgeBaseName"])
# 檢索知識庫
results = client.retrieve({
"knowledgeBaseName": "product_docs",
"retrievalQuery": {"type": "TEXT", "text": "your query"}
})
for item in results["data"]["retrievalResults"]:
print(item["content"])TypeScript
需安裝AgentStorage TypeScript SDK :npm install @tablestore/agent-storage/import { AgentStorageClient } from '@tablestore/agent-storage';
// 使用 API Key 初始化用戶端
const client = new AgentStorageClient({
apiKey: 'your-api-key',
endpoint: 'https://your-instance.cn-beijing.ots.aliyuncs.com',
instanceName: 'your-instance-name',
});
// 建立知識庫
await client.createKnowledgeBase({ knowledgeBaseName: 'product_docs' });
// 查看已建立的知識庫
const response = await client.listKnowledgeBase({});
for (const kb of response.data.knowledgeBases) {
console.log(kb.knowledgeBaseName);
}
// 檢索知識庫
const results = await client.retrieve({
knowledgeBaseName: 'product_docs',
retrievalQuery: { type: 'TEXT', text: '查詢文本' },
});
for (const item of results.data.retrievalResults) {
console.log(item.content);
}curl
通過 HTTP 要求直接存取時,在要求標頭中添加x-ots-apikey和x-ots-instancename欄位。
curl -X POST 'https://your-instance.cn-beijing.ots.aliyuncs.com/CreateKnowledgeBase' \
-H 'x-ots-instancename: your-instance-name' \
-H 'x-ots-apikey: your-api-key' \
-H 'Content-Type: application/json' \
-d '{"knowledgeBaseName": "product_docs"}'以下樣本展示如何通過 curl 查看已建立的知識庫列表。
curl -X POST 'https://your-instance.cn-beijing.ots.aliyuncs.com/ListKnowledgeBase' \
-H 'x-ots-instancename: your-instance-name' \
-H 'x-ots-apikey: your-api-key' \
-H 'Content-Type: application/json' \
-d '{}'使用限制
API Key 僅支援訪問知識儲存服務和記憶儲存服務的 API。如需訪問Table Store的其他 API,請使用 AccessKey 認證。
建立 API Key 時,系統會自動建立一個專屬 RAM 使用者並綁定
AliyunOTSFullAccess權限原則。API Key 的許可權等同於該 RAM 使用者的許可權,如需調整請前往 RAM 控制台修改對應使用者的權限原則。通過 API Key 訪問知識儲存服務和記憶儲存服務時,系統同時校正 API 操作許可權和
ots:CallWithBearerToken許可權。如果對應 RAM 使用者缺少其中任一許可權,請求將被拒絕。