CroupierCroupier
指南
架构
API 参考
开发
  • C++ SDK
  • Go SDK
  • Java SDK
  • JavaScript SDK
  • Python SDK
  • C# SDK
  • Lua SDK
分析
GitHub
指南
架构
API 参考
开发
  • C++ SDK
  • Go SDK
  • Java SDK
  • JavaScript SDK
  • Python SDK
  • C# SDK
  • Lua SDK
分析
GitHub
  • API 参考

    • API 概览
    • gRPC API
    • REST API
  • 运维管理

    • 运维 API
    • 运维核心 API
    • 运维简化 API
    • 管理员 API
    • 备份 API
    • 配置 API
    • 迁移 API
    • 监控 API
    • 节点 API
  • Agent & 函数

    • Agent API
    • 函数 API
    • 任务 API
    • /api/pack.html
    • Schema API
  • 认证与权限

    • 认证 API
    • 审批 API
    • 审计 API
    • 限流 API
  • 游戏管理

    • 游戏 API
    • 玩家 API
    • 实体 API
    • /api/component.html
    • 注册表 API
  • 消息通知

    • 消息 API
    • 告警 API
    • 支持 API
    • 工单 API
    • 反馈 API
  • 平台与集成

    • 平台 API
    • Provider API
    • 证书 API
    • 存储 API
  • 数据分析

    • 数据分析 API
    • 行为分析 API
    • 分析概览 API
    • 支付分析 API
    • 留存分析 API
  • 其他

    • 分配 API
    • 常见问题
    • 元数据 API
    • 配置文件 API
    • Workspace API

任务 API

1. "任务列表"

  1. route definition
  • Url: /api/v1/jobs
  • Method: GET
  • Request: JobListRequest
  • Response: JobListResponse
  1. request definition
type JobListRequest struct {
	Status string `form:"status,optional"`
	FunctionID string `form:"function_id,optional"`
	Actor string `form:"actor,optional"`
	GameID string `form:"game_id,optional"`
	Env string `form:"env,optional"`
	Page int `form:"page,optional,default=1"`
	Size int `form:"size,optional,default=20"`
}
  1. response definition
type JobListResponse struct {
	Jobs []JobItem `json:"jobs"`
	Total int `json:"total"`
}

2. "启动任务"

  1. route definition
  • Url: /api/v1/jobs
  • Method: POST
  • Request: JobStartRequest
  • Response: JobStartResponse
  1. request definition
type JobStartRequest struct {
	FunctionID string `json:"functionId"` // 函数ID
	Params interface{} `json:"params,optional"`
}
  1. response definition
type JobStartResponse struct {
	Code int `json:"code"`
	Message string `json:"message"`
	Data interface{} `json:"data,omitempty"`
}

3. "取消任务"

  1. route definition
  • Url: /api/v1/jobs/:id/cancel
  • Method: POST
  • Request: JobCancelRequest
  • Response: JobCancelResponse
  1. request definition
type JobCancelRequest struct {
	ID string `path:"id"` // 任务ID
}
  1. response definition
type JobCancelResponse struct {
	Code int `json:"code"`
	Message string `json:"message"`
	Data interface{} `json:"data,omitempty"`
}

4. "获取任务结果"

  1. route definition
  • Url: /api/v1/jobs/:id/result
  • Method: GET
  • Request: JobResultRequest
  • Response: JobResultResponse
  1. request definition
type JobResultRequest struct {
	ID string `path:"id"` // 任务ID
}
  1. response definition
type JobResultResponse struct {
	Code int `json:"code"`
	Message string `json:"message"`
	Data interface{} `json:"data,omitempty"`
}

5. "任务流(实时状态和日志)"

  1. route definition
  • Url: /api/v1/jobs/:jobId/stream
  • Method: GET
  • Request: StreamJobRequest
  • Response: StreamJobResponse
  1. request definition
type StreamJobRequest struct {
	JobID string `path:"jobId"`
}
  1. response definition
type StreamJobResponse struct {
	Code int `json:"code"`
	Message string `json:"message"`
	Data interface{} `json:"data,omitempty"`
}

兼容说明

  • Dashboard 仍会调用 /api/v1/function-calls* 读取函数调用历史。
  • 当前服务端提供了一个基于 jobs 的兼容层来承接这些请求,详见 function_call.md。
  • 该兼容层的目标是消除重构后的 404,不代表已经恢复完整的调用历史持久化模型。
在 GitHub 上编辑此页
最后更新: 2026/3/19 10:26
Prev
函数 API
Next
/api/pack.html