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/functions
  • Method: GET
  • Request: FunctionsListRequest
  • Response: FunctionsListResponse
  1. request definition
type FunctionsListRequest struct {
	Page int `form:"page,optional,default=1"`
	PageSize int `form:"pageSize,optional,default=20"`
	GameId string `form:"gameId,optional"`
	Category string `form:"category,optional"`
	Status int `form:"status,optional"`
}
  1. response definition
type FunctionsListResponse struct {
	Items []Function `json:"items"`
	Total int64 `json:"total"`
	Page int `json:"page"`
	Size int `json:"pageSize"`
}

2. "获取函数详情"

  1. route definition
  • Url: /api/v1/functions/:id
  • Method: GET
  • Request: FunctionDetailRequest
  • Response: FunctionDetailResponse
  1. request definition
type FunctionDetailRequest struct {
	ID string `path:"id"`
}
  1. response definition
type FunctionDetailResponse struct {
	Id string `json:"id"`
	Name string `json:"name"`
	Description string `json:"description"`
	Category string `json:"category"`
	GameId string `json:"gameId"`
	Status int `json:"status"`
	Version string `json:"version"`
	Instances int `json:"instances"`
	CreatedAt string `json:"createdAt"`
	UpdatedAt string `json:"updatedAt"`
	Descriptor FunctionDescriptor `json:"descriptor"`
}

type Function struct {
	Id string `json:"id"`
	Name string `json:"name"`
	Description string `json:"description"`
	Category string `json:"category"`
	GameId string `json:"gameId"`
	Status int `json:"status"`
	Version string `json:"version"`
	Instances int `json:"instances"`
	CreatedAt string `json:"createdAt"`
	UpdatedAt string `json:"updatedAt"`
}

type FunctionDescriptor struct {
	Input interface{} `json:"input"`
	Output interface{} `json:"output"`
	Schema interface{} `json:"schema"`
}

3. "删除函数"

  1. route definition
  • Url: /api/v1/functions/:id
  • Method: DELETE
  • Request: FunctionActionRequest
  • Response: -
  1. request definition
type FunctionActionRequest struct {
	ID string `path:"id"`
}
  1. response definition

4. "复制函数"

  1. route definition
  • Url: /api/v1/functions/:id/copy
  • Method: POST
  • Request: FunctionCopyRequest
  • Response: FunctionCopyResponse
  1. request definition
type FunctionCopyRequest struct {
	ID string `path:"id"`
}
  1. response definition
type FunctionCopyResponse struct {
	FunctionId string `json:"function_id"`
	NewId string `json:"new_id"`
}

5. "禁用函数"

  1. route definition
  • Url: /api/v1/functions/:id/disable
  • Method: POST
  • Request: FunctionActionRequest
  • Response: -
  1. request definition
type FunctionActionRequest struct {
	ID string `path:"id"`
}
  1. response definition

6. "启用函数"

  1. route definition
  • Url: /api/v1/functions/:id/enable
  • Method: POST
  • Request: FunctionActionRequest
  • Response: -
  1. request definition
type FunctionActionRequest struct {
	ID string `path:"id"`
}
  1. response definition

7. "获取函数实例"

  1. route definition
  • Url: /api/v1/functions/:id/instances
  • Method: GET
  • Request: FunctionInstancesRequest
  • Response: FunctionInstancesResponse
  1. request definition
type FunctionInstancesRequest struct {
	ID string `path:"id"`
}
  1. response definition
type FunctionInstancesResponse struct {
	Items []FunctionInstance `json:"items"`
}

8. "调用函数"

  1. route definition
  • Url: /api/v1/functions/:id/invoke
  • Method: POST
  • Request: FunctionInvokeRequest
  • Response: FunctionInvokeResponse
  1. request definition
type FunctionInvokeRequest struct {
	ID string `path:"id"`
	Params interface{} `json:"params,optional"`
	Payload interface{} `json:"payload,optional"`
	GameID string `json:"gameId,optional"`
	Env string `json:"env,optional"`
	Mode string `json:"mode,optional"`
	Route string `json:"route,optional"`
	TargetServiceID string `json:"target_service_id,optional"`
	HashKey string `json:"hash_key,optional"`
}
  1. response definition
type FunctionInvokeResponse struct {
	JobId string `json:"jobId"`
	JobID string `json:"jobID,omitempty"`
	Result interface{} `json:"result,omitempty"`
}

9. "获取函数权限"

  1. route definition
  • Url: /api/v1/functions/:id/permissions
  • Method: GET
  • Request: FunctionPermissionsRequest
  • Response: FunctionPermissionsResponse
  1. request definition
type FunctionPermissionsRequest struct {
	ID string `path:"id"`
}
  1. response definition
type FunctionPermissionsResponse struct {
	Items []FunctionPermission `json:"items"`
}

10. "更新函数权限"

  1. route definition
  • Url: /api/v1/functions/:id/permissions
  • Method: PUT
  • Request: FunctionPermissionsUpdateRequest
  • Response: FunctionPermissionsResponse
  1. request definition
type FunctionPermissionsUpdateRequest struct {
	ID string `path:"id"`
	Permissions []FunctionPermission `json:"permissions"`
}
  1. response definition
type FunctionPermissionsResponse struct {
	Items []FunctionPermission `json:"items"`
}

11. "发布函数"

  1. route definition
  • Url: /api/v1/functions/:id/publish
  • Method: POST
  • Request: FunctionPublishRequest
  • Response: FunctionPublishResponse
  1. request definition
type FunctionPublishRequest struct {
	ID string `path:"id"`
}
  1. response definition
type FunctionPublishResponse struct {
	ApprovalId string `json:"approvalId,omitempty"` // 如果需要审批
	Published bool `json:"published"`
}

12. "获取函数UI配置"

  1. route definition
  • Url: /api/v1/functions/:id/ui
  • Method: GET
  • Request: FunctionUIRequest
  • Response: FunctionUIResponse
  1. request definition
type FunctionUIRequest struct {
	ID string `path:"id"`
}
  1. response definition
type FunctionUIResponse struct {
	Schema interface{} `json:"schema"`
	Layout interface{} `json:"layout"`
	Components interface{} `json:"components"`
}

13. "更新函数UI配置"

  1. route definition
  • Url: /api/v1/functions/:id/ui
  • Method: PUT
  • Request: FunctionUIUpdateRequest
  • Response: FunctionUIResponse
  1. request definition
type FunctionUIUpdateRequest struct {
	ID string `path:"id"`
	Schema interface{} `json:"schema,optional"`
	Layout interface{} `json:"layout,optional"`
	Components interface{} `json:"components,optional"`
}
  1. response definition
type FunctionUIResponse struct {
	Schema interface{} `json:"schema"`
	Layout interface{} `json:"layout"`
	Components interface{} `json:"components"`
}

14. "获取函数UI配置历史"

  1. route definition
  • Url: /api/v1/functions/:id/ui/history
  • Method: GET
  • Request: FunctionUIHistoryRequest
  • Response: FunctionUIHistoryResponse
  1. request definition
type FunctionUIHistoryRequest struct {
	ID string `path:"id"`
}
  1. response definition
type FunctionUIHistoryResponse struct {
	Items []FunctionUIHistoryItem `json:"items"`
}

15. "回滚函数UI配置"

  1. route definition
  • Url: /api/v1/functions/:id/ui/rollback
  • Method: POST
  • Request: FunctionUIRollbackRequest
  • Response: FunctionUIRollbackResponse
  1. request definition
type FunctionUIRollbackRequest struct {
	ID      string `path:"id"`
	Version int    `json:"version"`
}
  1. response definition
type FunctionUIRollbackResponse struct {
	AppliedVersion int                 `json:"appliedVersion"`
	Current        *FunctionUIResponse `json:"current"`
}

16. "批量复制函数"

  1. route definition
  • Url: /api/v1/functions/batch-copy
  • Method: POST
  • Request: BatchCopyFunctionsRequest
  • Response: BatchCopyFunctionsResponse
  1. request definition
type BatchCopyFunctionsRequest struct {
	FunctionIds []string `json:"function_ids"`
}
  1. response definition
type BatchCopyFunctionsResponse struct {
	Updated int `json:"updated"`
	Failed []string `json:"failed"`
	Copied []string `json:"copied"` // 新复制的函数ID列表
}

17. "批量删除函数"

  1. route definition
  • Url: /api/v1/functions/batch-delete
  • Method: POST
  • Request: BatchDeleteFunctionsRequest
  • Response: BatchDeleteFunctionsResponse
  1. request definition
type BatchDeleteFunctionsRequest struct {
	FunctionIds []string `json:"function_ids"`
}
  1. response definition
type BatchDeleteFunctionsResponse struct {
	Updated int `json:"updated"`
	Failed []string `json:"failed"`
}

18. "批量更新函数状态"

  1. route definition
  • Url: /api/v1/functions/batch-update
  • Method: POST
  • Request: BatchUpdateFunctionsRequest
  • Response: BatchUpdateFunctionsResponse
  1. request definition
type BatchUpdateFunctionsRequest struct {
	FunctionIds []string `json:"function_ids"`
	Enabled bool `json:"enabled"`
}
  1. response definition
type BatchUpdateFunctionsResponse struct {
	Updated int `json:"updated"`
	Failed []string `json:"failed"`
}

19. "获取函数描述符列表"

  1. route definition
  • Url: /api/v1/functions/descriptors
  • Method: GET
  • Request: DescriptorsRequest
  • Response: DescriptorsResponse
  1. request definition
type DescriptorsRequest struct {
	Type string `form:"type,optional"`
	GameId string `form:"gameId,optional"`
}
  1. response definition
type DescriptorsResponse struct {
	Items []Descriptor `json:"items"`
}

20. "获取待处理函数"

  1. route definition
  • Url: /api/v1/functions/pending
  • Method: GET
  • Request: FunctionsPendingRequest
  • Response: FunctionsPendingResponse
  1. request definition
type FunctionsPendingRequest struct {
}
  1. response definition
type FunctionsPendingResponse struct {
	Items []PendingFunction `json:"items"`
}

21. "批量获取函数 OpenAPI"

  1. route definition
  • Url: /api/v1/functions/_openapi-batch
  • Method: POST
  • Request: BatchGetSpecRequest
  • Response: map[string]interface{}
  1. request definition
type BatchGetSpecRequest struct {
	FunctionIDs []string `json:"function_ids"`
}
  1. response definition
// key 为 function id,value 为对应的 OpenAPI Operation;未找到时返回 null
map[string]interface{}

说明

  • 该接口用于 Dashboard 批量读取函数 OpenAPI,避免逐个请求。
  • 当前返回值直接透传注册表中的 OpenAPI operation 对象。
在 GitHub 上编辑此页
最后更新: 2026/3/19 10:26
Prev
Agent API
Next
任务 API