Tablestore:Gestion des clés API

Choisir une méthode d'authentification

Choisissez une méthode d'authentification en fonction des ressources auxquelles votre application doit accéder.

Si vous appelez uniquement les API de stockage de connaissances et de mémoire, nous vous recommandons d'utiliser une clé API. Si vous devez télécharger des fichiers locaux vers OSS puis les importer dans une base de connaissances, ou accéder à d'autres API Tablestore, utilisez un AccessKey ou des informations d'identification temporaires STS. Pour plus d'informations sur la création, l'autorisation et la configuration des politiques RAM pour un AccessKey, consultez la section Configurer les autorisations d'accès.

Créer une clé API

1. Connectez-vous à la console Tablestore.

2. Dans le volet de navigation de gauche, cliquez sur API Key.

3. Sur la page de gestion des clés API, cliquez sur Create API Key.

4. Dans la boîte de dialogue Create API Key, définissez le paramètre Expiration time.

5. Cliquez sur Create.

Utiliser une clé API

Vous pouvez utiliser une clé API pour accéder aux services de stockage de connaissances et de mémoire via le SDK ou curl. Une clé API prend en charge toutes les opérations API des deux services, y compris les opérations de création, de requête, de récupération et de suppression.

from tablestore_agent_storage import AgentStorageClient

# Initialize the client with an 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",
)

# Create a knowledge base
client.create_knowledge_base({"knowledgeBaseName": "product_docs"})

# List existing knowledge bases
response = client.list_knowledge_base()
for kb in response["data"]["knowledgeBases"]:
    print(kb["knowledgeBaseName"])

# Retrieve from a knowledge base
results = client.retrieve({
    "knowledgeBaseName": "product_docs",
    "retrievalQuery": {"type": "TEXT", "text": "your query"}
})
for item in results["data"]["retrievalResults"]:
    print(item["content"])

import { AgentStorageClient } from '@tablestore/agent-storage';

// Initialize the client with an API Key
const client = new AgentStorageClient({
  apiKey: 'your-api-key',
  endpoint: 'https://your-instance.cn-beijing.ots.aliyuncs.com',
  instanceName: 'your-instance-name',
});

// Create a knowledge base
await client.createKnowledgeBase({ knowledgeBaseName: 'product_docs' });

// List existing knowledge bases
const response = await client.listKnowledgeBase({});
for (const kb of response.data.knowledgeBases) {
  console.log(kb.knowledgeBaseName);
}

// Retrieve from a knowledge base
const results = await client.retrieve({
  knowledgeBaseName: 'product_docs',
  retrievalQuery: { type: 'TEXT', text: 'your query' },
});
for (const item of results.data.retrievalResults) {
  console.log(item.content);
}

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 -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 '{}'

Limites

• Une clé API ne peut accéder qu'aux API du service de stockage de connaissances et du service de stockage de mémoire. Pour accéder à d'autres API Tablestore, utilisez l'authentification par AccessKey.

• Lorsque vous créez une clé API, le système crée automatiquement un utilisateur RAM dédié et attache la politique AliyunOTSFullAccess à cet utilisateur. Les autorisations de la clé API sont équivalentes à celles de l'utilisateur RAM. Pour ajuster les autorisations, accédez à la console RAM et modifiez la politique de l'utilisateur correspondant.

• Lorsque vous accédez aux services de stockage de connaissances et de mémoire avec une clé API, le système vérifie à la fois l'autorisation d'opération API et l'autorisation ots:CallWithBearerToken . Si l'utilisateur RAM correspondant ne dispose pas de l'une ou l'autre de ces autorisations, la requête est rejetée.