开发者文档

就绪检查

GET/api/health/ready

权限与前置条件

无需登录；仅返回公开状态或当前会话摘要。

此接口仅支持浏览器登录，不接受 API Key。Cookie 写入仍需允许来源的 Origin 和 X-Requested-With: suren360。不能同时携带 Cookie 与 API Key。所有路径参数须使用真实 ID。

请求参数

Query 查询参数

无额外字段；联合结构请查看完整定义。

查看完整请求 JSON Schema

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

调用示例

先通过浏览器统一登录，使用受控环境中的已有会话。请替换部署地址与示例字段，不要将凭证粘贴到聊天或日志中。

cURL · 示例占位值需替换

curl --request GET \
  'https://YOUR_DEPLOYMENT_HOST/api/health/ready' \
  --cookie "$SUREN360_COOKIE"

响应结构

成功返回 HTTP 200 的 JSON 对象。下方为响应结构定义，不是虚构的业务数据。

字段	类型	必填	约束
`status`	string	是	`{"const":"ok"}`
`database`	boolean	是	`{"const":true}`
`redis`	boolean	是	`{"const":true}`

查看完整响应 JSON Schema

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "const": "ok"
    },
    "database": {
      "type": "boolean",
      "const": true
    },
    "redis": {
      "type": "boolean",
      "const": true
    }
  },
  "required": [
    "status",
    "database",
    "redis"
  ],
  "additionalProperties": false
}

查看错误码与重试规则