表格存储 API Key 管理 - 表格存储

表格存储支持通过 API Key 认证方式访问知识存储服务和记忆存储服务。使用 API Key 无需管理 AccessKey 密钥对，支持独立创建和吊销，且强制 HTTPS 传输，适用于 AI 应用的快速集成场景。

认证方式对比

表格存储支持以下两种认证方式。

认证方式	适用场景	支持的接口
AccessKey（AK/SK）	全功能访问	全部表格存储接口
API Key	AI 应用集成，无需管理密钥对	仅知识存储服务和记忆存储服务的 API

创建 API Key

登录表格存储控制台。
在左侧导航栏，单击API Key。
在 API Key 管理页面，单击创建 API Key。
在创建 API Key 对话框，设置过期时间。
单击创建。

重要

请妥善保管密钥值，仅在创建时显示一次，无法再次查看。

使用 API Key

通过 SDK 或 curl 使用 API Key 访问知识存储服务和记忆存储服务。API Key 支持两项服务的全部 API 操作，包括创建、查询、检索和删除。

说明

通过 API Key 访问时，必须使用 HTTPS 协议的访问地址。

SDK

知识存储服务和记忆存储服务提供 Python SDK 和 TypeScript SDK。初始化客户端时，使用 api_key 参数替代 AccessKey 凭证。

Python

安装 SDK。

pip install tablestore-agent-storage

以下示例展示如何使用 API Key 创建知识库并执行语义检索。

from 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

安装 SDK。

npm install @tablestore/agent-storage

以下示例展示如何使用 API Key 创建知识库并执行语义检索。

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 创建知识库。

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。如需访问表格存储的其他 API，请使用 AccessKey 认证。
创建 API Key 时，系统会自动创建一个专属 RAM 用户并绑定 AliyunOTSFullAccess 权限策略。API Key 的权限等同于该 RAM 用户的权限，如需调整请前往 RAM 控制台修改对应用户的权限策略。
通过 API Key 访问知识存储服务和记忆存储服务时，系统同时校验 API 操作权限和 ots:CallWithBearerToken 权限。如果对应 RAM 用户缺少其中任一权限，请求将被拒绝。