基础信息
API 基础URL
认证方式
部分API请求都需要在HTTP头中包含认证信息:请求格式
- Content-Type:
application/json
- 字符编码: UTF-8
- 请求方法: GET、POST
响应格式
所有API响应都采用统一的JSON格式:API 概览
核心功能
实例管理
管理GPU实例的完整生命周期: 主要接口:POST /api/open/v2/instance/create_by_pod
- 通过Pod创建实例POST /api/open/v2/instance/create_by_image
- 通过镜像创建实例GET /api/open/v2/instance/list
- 获取实例列表POST /api/open/v2/instance/startup
- 启动实例POST /api/open/v2/instance/shutdown_timer
- 停止实例POST /api/open/v2/instance/restart
- 重启实例
计费管理
实时监控费用和管理预算:GET /api/open/v2/balance/info
- 查询账户余额GET /api/open/v2/bill/list
- 获取账单详情GET /api/open/v2/recharge/list
- 查询充值记录
资源管理
获取平台资源信息:GET /api/open/v2/pod/list
- 获取Pod列表GET /api/open/v2/gpu/list
- 获取GPU列表GET /api/open/v2/image/market/list
- 获取市场镜像列表
快速开始
1. 获取API Key
登录 晨羽智云控制台,在”API管理”页面创建新的API密钥。2. 初始化客户端
状态码说明
HTTP状态码
状态码 | 描述 | 说明 |
---|---|---|
200 | OK | 请求成功 |
400 | Bad Request | 请求参数错误 |
401 | Unauthorized | 认证失败 |
403 | Forbidden | 权限不足 |
404 | Not Found | 资源不存在 |
429 | Too Many Requests | 请求过于频繁 |
500 | Internal Server Error | 服务器内部错误 |
错误处理
错误响应格式
当前版本
- API版本: v2
- 发布日期: 2025-08-01
安全建议
- API Key管理: 将API Key存储在环境变量中,不要硬编码
- 定期轮换: 定期更新API Key以提高安全性