6 个图像模型 · 能力与价格一处查看查看价格 →
API 文档服务就绪检查

OGA 开发者中心

API v1 · 最后核对 2026-08-15

服务就绪检查

检查任务库、私有资源与 Worker 是否具备接单条件。

GET/health/ready
浏览常用接口

接口说明

只有 data.ready 为 true 时才应把新业务流量导入该实例。未就绪会返回非 2xx 错误信封,调用方不应把失败伪装成可用。

认证:无需认证

请求

此接口没有路径、查询或请求体参数。

响应

JSON 接口使用统一响应信封。HTTP 状态表达请求结果,业务错误不会伪装成 HTTP 200。

HTTP含义
200请求成功
500服务内部错误
503实例尚未就绪

完整成功响应示例(可选字段可能因状态不同而变化)

{
  "code": 0,
  "message": "success",
  "data": {
    "status": "ok",
    "ready": true,
    "components": {
      "api": {
        "status": "ok"
      },
      "task_store": {
        "status": "ok",
        "kind": "mysql-runtime"
      },
      "asset_store": {
        "status": "ok",
        "kind": "encrypted-private-filesystem"
      },
      "worker": {
        "status": "ok"
      },
      "shared_worker_runtime": {
        "status": "ok",
        "kind": "external"
      },
      "real_channel_routing": {
        "status": "ok",
        "kind": "external"
      },
      "scheduler_runtime": {
        "status": "ok",
        "kind": "advisory"
      },
      "identity_mirror": {
        "status": "ok",
        "kind": "advisory"
      }
    }
  },
  "request_id": "8f25b42f-2ed1-4ad7-99de-61d7f779bc7b",
  "timestamp": "2026-08-10T00:00:00Z"
}

重要边界

  • 公开只读,不创建任务,也不会触发上游调用。

查看机器可读 OpenAPI

代码与在线调试

GET · /health/ready

curl -X GET "$OGA_BASE_URL/health/ready" \
  -H "X-Request-Id: <UUID_V4>" \
  -H "Accept-Language: zh-CN"