API 参考文档
智慧云 提供 RESTful API,支持 JSON 请求/响应。完整 OpenAPI 规范:openapi.json。
鉴权方式
在请求头中添加 Authorization: Bearer {api_key} 进行鉴权。API Key 可在 控制台 生成。
端点列表
| 方法 | 路径 | 说明 | 认证 |
|---|---|---|---|
| GET | /api/v1/users | 获取用户列表 (分页) | 需要 |
| POST | /api/v1/users | 创建用户 | 需要 (admin) |
| GET | /api/v1/projects | 获取项目列表 (分页) | 需要 |
| GET | /api/v1/projects/{id}/keys | 获取项目 API Keys | 需要 (admin) |
| GET | /api/beta/instances | 获取计算实例 (Beta) | 需要 |
| GET | /api/internal/audit | 审计日志 (内部) | 内部 |
| GET | /api/internal/logs | 系统日志 (内部) | 内部 |
通用请求头
| Header | 类型 | 必填 | 说明 |
|---|---|---|---|
Authorization | string | 是 | Bearer {api_key} |
Content-Type | string | POST/PUT | application/json |
X-Request-Id | string | 否 | 请求追踪 ID,用于日志关联 |
分页参数
支持分页的接口接受以下 query 参数:
| 参数 | 类型 | 默认 | 说明 |
|---|---|---|---|
page | integer | 1 | 页码 (从 1 开始) |
per_page | integer | 20 | 每页条数 (最大 100) |
错误响应格式
{
"error": "unauthorized",
"message": "API Key 无效或已过期",
"request_id": "req_ac4be28b3ae3e49f23311950fdfc4030"
}