Manajemen kunci API - Tablestore - Tablestore - Alibaba Cloud Documentation Center

Tablestore mendukung autentikasi kunci API untuk mengakses Knowledge Store dan Memory Store. Kunci API dapat dibuat dan dicabut secara independen tanpa perlu mengelola pasangan AccessKey, serta memerlukan transportasi melalui HTTPS.

Metode autentikasi

Tablestore mendukung metode autentikasi berikut.

Metode autentikasi	Kasus penggunaan	API yang didukung
AccessKey (AK/SK)	Akses penuh ke semua fitur	Semua API Tablestore
API key	Integrasi aplikasi AI tanpa mengelola pasangan kunci	Hanya API Knowledge Store dan Memory Store

Buat kunci API

Masuk ke Konsol Tablestore.
Pada panel navigasi di sebelah kiri, klik API Key.
Pada halaman Manajemen Kunci API, klik Create API Key.
Pada kotak dialog Create API Key, atur Expiration Time.
Klik Create.

Penting

Simpan nilai kunci di lokasi yang aman. Nilai kunci hanya ditampilkan saat pembuatan dan tidak dapat diambil kembali nanti.

Gunakan kunci API

Akses Knowledge Store dan Memory Store dengan kunci API melalui SDK atau curl. Kunci API mendukung semua operasi API untuk kedua layanan tersebut.

Catatan

Akses dengan kunci API memerlukan titik akhir HTTPS.

SDK

SDK Python dan TypeScript tersedia untuk Knowledge Store dan Memory Store. Untuk menginisialisasi klien, gunakan parameter api_key sebagai ganti kredensial AccessKey.

Python

Instal SDK.

pip install tablestore-agent-storage

Contoh berikut membuat basis pengetahuan dan menjalankan pencarian semantik dengan kunci API.

from tablestore_agent_storage import AgentStorageClient

# Inisialisasi client dengan kunci API
client = AgentStorageClient(
    api_key="your-api-key",
    ots_endpoint="https://your-instance.cn-beijing.ots.aliyuncs.com",
    ots_instance_name="your-instance-name",
)

# Buat basis pengetahuan
client.create_knowledge_base({"knowledgeBaseName": "product_docs"})

# Daftar basis pengetahuan
response = client.list_knowledge_base()
for kb in response["data"]["knowledgeBases"]:
    print(kb["knowledgeBaseName"])

# Ambil data dari basis pengetahuan
results = client.retrieve({
    "knowledgeBaseName": "product_docs",
    "retrievalQuery": {"type": "TEXT", "text": "your query"}
})
for item in results["data"]["retrievalResults"]:
    print(item["content"])

TypeScript

Instal SDK.

npm install @tablestore/agent-storage

Contoh berikut membuat basis pengetahuan dan menjalankan pencarian semantik dengan kunci API.

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

// Inisialisasi client dengan kunci API
const client = new AgentStorageClient({
  apiKey: 'your-api-key',
  endpoint: 'https://your-instance.cn-beijing.ots.aliyuncs.com',
  instanceName: 'your-instance-name',
});

// Buat basis pengetahuan
await client.createKnowledgeBase({ knowledgeBaseName: 'product_docs' });

// Daftar basis pengetahuan
const response = await client.listKnowledgeBase({});
for (const kb of response.data.knowledgeBases) {
  console.log(kb.knowledgeBaseName);
}

// Ambil data dari basis pengetahuan
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

Tambahkan header x-ots-apikey dan x-ots-instancename ke permintaan HTTP Anda.

Contoh berikut membuat basis pengetahuan dengan 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"}'

Contoh berikut menampilkan semua basis pengetahuan dengan 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 '{}'

Batasan

Kunci API hanya mendukung API Knowledge Store dan Memory Store. Untuk mengakses API Tablestore lainnya, gunakan autentikasi AccessKey.
Saat Anda membuat kunci API, RAM user khusus akan dibuat dengan kebijakan AliyunOTSFullAccess yang dilampirkan. Kunci API mewarisi izin dari RAM user ini. Untuk menyesuaikan izin, ubah kebijakan pengguna di Konsol RAM.
Jika RAM user tidak memiliki izin operasi API atau izin ots:CallWithBearerToken, permintaan ke Knowledge Store dan Memory Store melalui kunci API akan gagal.