SQLPub Serverless MySQL

SQLPub API 使用指南

SQLPub 提供 REST API，方便开发者通过程序查询和执行 SQL。API Key 在控制台 个人中心 → 密钥管理（/account/apikey）中创建和管理。

创建 API Key

登录控制台。
进入 个人中心 → 密钥管理。
点击创建，设置名称与权限：
- query：只读查询
- execute：执行写操作
妥善保存 Key，创建后仅显示一次。

认证

所有请求需在 Header 中携带 API Key：

Authorization: Bearer <your_api_key>
Content-Type: application/json

基础 URL

https://api.sqlpub.com/api/v1

常用接口

执行查询

POST /databases/{database_name}/query

curl -X POST "https://api.sqlpub.com/api/v1/databases/my_db/query" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"sql": "SELECT * FROM users LIMIT 10"}'

执行写操作

POST /databases/{database_name}/execute

curl -X POST "https://api.sqlpub.com/api/v1/databases/my_db/execute" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"sql": "INSERT INTO users (name) VALUES (\"test\")"}'

注意事项

API Key 请妥善保管，不要提交到代码仓库。
可在密钥管理页面随时启用、禁用或删除 Key。
高频请求请做好节流，避免触发限流。
控制台密钥管理页面提供完整的调用示例。