接口参考系统与健康检查
获取系统信息
GET /api/v1/system,getSystemInfo 的请求参数和响应结构。
GET /api/v1/system
| 项目 | 内容 |
|---|---|
| 操作标识 | getSystemInfo |
| 认证 | 无需用户登录 |
响应
| HTTP 状态 | 含义 |
|---|---|
| 200 | 成功 |
| 500 | 内部错误 |
200 · application/json 响应结构
| 字段 | 类型 | 必填 | 说明与约束 |
|---|---|---|---|
| data | SystemInfo | 是 | — |
| request_id | string | 是 | — |
{
"$ref": "#/$defs/SystemInfoResponse",
"$defs": {
"SystemInfoResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"data": {
"$ref": "#/$defs/SystemInfo"
},
"request_id": {
"type": "string"
}
},
"required": [
"data",
"request_id"
]
},
"SystemInfo": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"version": {
"type": "string"
},
"phase": {
"type": "string",
"enum": [
"bootstrap"
]
},
"modules": {
"type": "object",
"additionalProperties": {
"$ref": "#/$defs/ImplementationState"
}
},
"compute_backend": {
"type": "string",
"enum": [
"native_kvm"
],
"description": "本项目仅开发自研 KVM 管理后端;实际能力以 modules 的实现状态为准。"
},
"host_transport": {
"type": "string",
"enum": [
"grpc_mtls"
],
"description": "自研主机代理的管理通道;不代表实例写操作已经实现。"
}
},
"required": [
"name",
"version",
"phase",
"modules",
"compute_backend",
"host_transport"
]
},
"ImplementationState": {
"type": "string",
"enum": [
"implemented",
"planned"
]
}
}
}500 · application/json 响应结构
{
"$ref": "#/$defs/ErrorResponse",
"$defs": {
"ErrorResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"error": {
"$ref": "#/$defs/ErrorDetail"
},
"request_id": {
"type": "string"
}
},
"required": [
"error",
"request_id"
]
},
"ErrorDetail": {
"type": "object",
"additionalProperties": false,
"properties": {
"code": {
"type": "string",
"enum": [
"NOT_IMPLEMENTED",
"NOT_FOUND",
"AUTH_REQUIRED",
"FORBIDDEN",
"VALIDATION_FAILED",
"CONFLICT",
"SERVICE_UNAVAILABLE",
"INTERNAL_ERROR",
"RATE_LIMITED"
]
},
"message": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"required": [
"code",
"message",
"retryable"
]
}
}
}响应中的 request_id 用于排查请求;异步操作以任务最终状态为准。参阅调用约定、异步任务和错误处理。
本页由版本化 OpenAPI 契约生成。通用资源响应允许的任意字段以运行服务为准,不据此推断尚未定义的字段。
