Skip to main content

基础信息

API 基础URL

认证方式

部分API请求都需要在HTTP头中包含认证信息:

请求格式

  • Content-Type: application/json
  • 字符编码: UTF-8
  • 请求方法: GET、POST

响应格式

所有API响应都采用统一的JSON格式:

API 概览

实例管理

创建、启动、停止、重启GPU实例,管理实例生命周期

账户信息

查询余额、充值记录、账单明细等账户信息

资源查询

获取可用Pod、GPU型号、镜像等资源信息

Pod管理

获取应用市场Pod列表和相关信息

工作流管理

查询工作流市场、提交运行任务、获取进度日志和输出结果

核心功能

实例管理

管理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 - 获取市场镜像列表

工作流管理

调用公开发布的工作流,以及当前 API Key 所属用户自己的已发布工作流,并查询运行结果:
  • GET /api/open/v2/workflow/market/list - 查询工作流市场列表
  • GET /api/open/v2/workflow/market/info - 查询工作流详情和参数清单
  • POST /api/open/v2/workflow/run/submit - 提交工作流运行
  • GET /api/open/v2/workflow/run/list - 查询工作流运行列表
  • GET /api/open/v2/workflow/run/info - 查询工作流运行详情
  • GET /api/open/v2/workflow/run/execution - 查询执行进度、日志和输出结果

快速开始

1. 获取API Key

登录 晨羽智云控制台,在”API管理”页面创建新的API密钥。

2. 初始化客户端

状态码说明

HTTP状态码

错误处理

错误响应格式

当前版本

  • API版本: v2
  • 发布日期: 2025-08-01

安全建议

  • API Key管理: 将API Key存储在环境变量中,不要硬编码
  • 定期轮换: 定期更新API Key以提高安全性

获取帮助

API文档

查看详细的API接口文档和示例

常见问题

查看API使用的常见问题和解决方案

联系支持

遇到问题?我们的技术团队随时为您提供帮助