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类型必填说明
AuthorizationstringBearer {api_key}
Content-TypestringPOST/PUTapplication/json
X-Request-Idstring请求追踪 ID,用于日志关联

分页参数

支持分页的接口接受以下 query 参数:

参数类型默认说明
pageinteger1页码 (从 1 开始)
per_pageinteger20每页条数 (最大 100)

错误响应格式

{
  "error": "unauthorized",
  "message": "API Key 无效或已过期",
  "request_id": "req_ac4be28b3ae3e49f23311950fdfc4030"
}