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/ops/config
  • Method: GET
  • Request: OpsConfigRequest
  • Response: OpsConfigResponse
  1. request definition
type OpsConfigRequest struct {
}
  1. response definition
type OpsConfigResponse struct {
	MaintenanceMode bool `json:"maintenanceMode"`
	HealthCheck interface{} `json:"healthCheck"`
	Notifications interface{} `json:"notifications"`
}

type OpsConfig struct {
	MaintenanceMode bool `json:"maintenanceMode"`
	HealthCheck interface{} `json:"healthCheck"`
	Notifications interface{} `json:"notifications"`
}

2. "获取函数列表"

  1. route definition
  • Url: /api/v1/ops/functions
  • Method: GET
  • Request: OpsFunctionsRequest
  • Response: OpsFunctionsResponse
  1. request definition
type OpsFunctionsRequest struct {
	GameId string `form:"gameId,optional"`
}
  1. response definition
type OpsFunctionsResponse struct {
	Items []OpsFunction `json:"items"`
}

3. "获取健康状态"

  1. route definition
  • Url: /api/v1/ops/health
  • Method: GET
  • Request: OpsHealthGetRequest
  • Response: OpsHealthResponse
  1. request definition
type OpsHealthGetRequest struct {
}
  1. response definition
type OpsHealthResponse struct {
	Status string `json:"status"`
	Checks interface{} `json:"checks"`
}

4. "更新健康检查配置"

  1. route definition
  • Url: /api/v1/ops/health
  • Method: PUT
  • Request: OpsHealthUpdateRequest
  • Response: OpsHealthResponse
  1. request definition
type OpsHealthUpdateRequest struct {
	Config interface{} `json:"config"`
}
  1. response definition
type OpsHealthResponse struct {
	Status string `json:"status"`
	Checks interface{} `json:"checks"`
}

5. "运行健康检查"

  1. route definition
  • Url: /api/v1/ops/health/run
  • Method: POST
  • Request: OpsHealthRunRequest
  • Response: OpsHealthResponse
  1. request definition
type OpsHealthRunRequest struct {
}
  1. response definition
type OpsHealthResponse struct {
	Status string `json:"status"`
	Checks interface{} `json:"checks"`
}

6. "获取维护模式状态"

  1. route definition
  • Url: /api/v1/ops/maintenance
  • Method: GET
  • Request: OpsMaintenanceGetRequest
  • Response: OpsMaintenanceResponse
  1. request definition
type OpsMaintenanceGetRequest struct {
}
  1. response definition
type OpsMaintenanceResponse struct {
	Enabled bool `json:"enabled"`
	Reason string `json:"reason"`
	StartAt string `json:"startAt"`
	EndAt string `json:"endAt"`
}

7. "更新维护模式"

  1. route definition
  • Url: /api/v1/ops/maintenance
  • Method: PUT
  • Request: OpsMaintenanceUpdateRequest
  • Response: OpsMaintenanceResponse
  1. request definition
type OpsMaintenanceUpdateRequest struct {
	Enabled bool `json:"enabled"`
	Reason string `json:"reason,optional"`
	EndAt string `json:"endAt,optional"`
}
  1. response definition
type OpsMaintenanceResponse struct {
	Enabled bool `json:"enabled"`
	Reason string `json:"reason"`
	StartAt string `json:"startAt"`
	EndAt string `json:"endAt"`
}

8. "获取系统指标"

  1. route definition
  • Url: /api/v1/ops/metrics
  • Method: GET
  • Request: OpsMetricsRequest
  • Response: OpsMetricsResponse
  1. request definition
type OpsMetricsRequest struct {
	From string `form:"from,optional"`
	To string `form:"to,optional"`
}
  1. response definition
type OpsMetricsResponse struct {
	CPU interface{} `json:"cpu"`
	Memory interface{} `json:"memory"`
	QPS interface{} `json:"qps"`
}

9. "获取消息队列状态"

  1. route definition
  • Url: /api/v1/ops/mq
  • Method: GET
  • Request: OpsMQRequest
  • Response: OpsMQResponse
  1. request definition
type OpsMQRequest struct {
}
  1. response definition
type OpsMQResponse struct {
	Status interface{} `json:"status"`
}

10. "获取通知配置"

  1. route definition
  • Url: /api/v1/ops/notifications
  • Method: GET
  • Request: OpsNotificationsGetRequest
  • Response: OpsNotificationsResponse
  1. request definition
type OpsNotificationsGetRequest struct {
}
  1. response definition
type OpsNotificationsResponse struct {
	Email interface{} `json:"email"`
	Webhook interface{} `json:"webhook"`
	Slack interface{} `json:"slack"`
}

11. "更新通知配置"

  1. route definition
  • Url: /api/v1/ops/notifications
  • Method: PUT
  • Request: OpsNotificationsUpdateRequest
  • Response: OpsNotificationsResponse
  1. request definition
type OpsNotificationsUpdateRequest struct {
	Email interface{} `json:"email,optional"`
	Webhook interface{} `json:"webhook,optional"`
	Slack interface{} `json:"slack,optional"`
}
  1. response definition
type OpsNotificationsResponse struct {
	Email interface{} `json:"email"`
	Webhook interface{} `json:"webhook"`
	Slack interface{} `json:"slack"`
}

12. "获取服务列表"

  1. route definition
  • Url: /api/v1/ops/services
  • Method: GET
  • Request: OpsServicesRequest
  • Response: OpsServicesResponse
  1. request definition
type OpsServicesRequest struct {
}
  1. response definition
type OpsServicesResponse struct {
	Items []OpsService `json:"items"`
}
在 GitHub 上编辑此页
最后更新: 2026/3/19 10:26
Prev
运维 API
Next
运维简化 API