API 参考
API 参考
本页列出应用程序调用的 Kibotos API 包：kibotos.ctrl.v1 管理 Workspace 及其数据，kibotos.operator.v1 运维部署，kibotos.enrollment.v1 取得身份。每个服务一页，由 proto 文件及其中的注释生成，列出它的方法以及每个方法的请求与响应，注释保持英文。
每个方法都是 Connect RPC，路径写在方法一节里，在所属服务注明的端点上调用。node 数据面另有两个 HTTP 端点，列在本页末尾。身份与调用方式见 API 概览。
| 包 | 服务 | 多个服务共用的消息与枚举 |
|---|---|---|
kibotos.ctrl.v1 | 15 | kibotos.ctrl.v1 类型 |
kibotos.operator.v1 | 7 | kibotos.operator.v1 类型 |
kibotos.enrollment.v1 | 1 | — |
kibotos.ctrl.v1
| 服务 | 端点 | 说明 |
|---|---|---|
ServerInfoService | ctrl API | ServerInfoService exposes the source revision this endpoint was built from and the capabilities it serves, so a client can check them before it starts a business operation. |
TemplateService | ctrl API | TemplateService exposes the deployment catalog without revealing private delivery or materialization details. |
WorkspaceService | ctrl API | WorkspaceService owns the Native Workspace lifecycle and stable identity. |
VolumeService | ctrl API | VolumeService owns the Native logical Volume lifecycle. |
ExposureService | ctrl API | ExposureService turns one HTTP port inside a guest into a stable public hostname. |
EgressService | ctrl API | EgressService owns caller-owned egress endpoints. |
ResolverService | ctrl API | ResolverService owns caller-chosen DNS upstreams. |
TransferService | ctrl API | TransferService owns Workspace transfer intent and provider-neutral artifact metadata. |
WorkspaceObservationService | ctrl API | WorkspaceObservationService reports deletion cleanup without exposing execution or host implementation identities. |
WorkspaceMetricsService | ctrl API | WorkspaceMetricsService reads a Workspace's resource readings back from the deployment's metrics store. |
DataPlaneSessionService | ctrl API | DataPlaneSessionService issues short-lived credentials for one available workspace. |
ServiceConnectionService | node 数据面 | ServiceConnectionService transports raw bytes to one precisely authorized guest service. |
FilesystemService | node 数据面 | FilesystemService performs metadata operations on the Workspace filesystem: stat, listing, directory creation, move, removal, and directory watching. |
ProcessService | node 数据面 | ProcessService owns reconnectable pipe and PTY processes. |
DesktopService | node 数据面 | DesktopService captures the Workspace desktop and delivers pointer and keyboard input to it. |
kibotos.operator.v1
| 服务 | 端点 | 说明 |
|---|---|---|
ArtifactPublicationService | ctrl API | ArtifactPublicationService is an Operator-only, single-kind artifact publication API. |
TemplateLifecycleService | ctrl API | TemplateLifecycleService is an Operator-only admission surface. |
TemplateCatalogService | ctrl API | TemplateCatalogService is the Operator-only Template catalog admission surface: it answers which revisions a Template may be created from and which one it defaults to, and it carries the three named catalog changes. |
NodeRegistrationService | ctrl API | NodeRegistrationService is the Operator-only view and desired-state surface for nodes admitted to this control plane. |
PlatformCatalogService | ctrl API | PlatformCatalogService is the Operator-only Platform catalog surface: it answers what has been registered, which revision each PlatformKey currently defaults to, and it carries the three named catalog changes. |
ArtifactRetentionService | ctrl API | ArtifactRetentionService is the Operator-only reclamation surface for the artifact store. |
EnrollmentGrantService | ctrl API | EnrollmentGrantService lets an authenticated Operator create one-time enrollment grants for other Operators or for exact node IDs, and revoke a principal. |
kibotos.enrollment.v1
| 服务 | 端点 | 说明 |
|---|---|---|
EnrollmentService | Operator API 与 node API | EnrollmentService is mounted on both the Operator API and the node API. |
HTTP 端点
除 Connect 服务外，node 数据面还在数据面会话的 endpoint 上提供以下端点。
| 端点 | 说明 |
|---|---|
/v1/files | Reads and writes the content of one file in the guest. |
/v1/service | Connects to one TCP loopback port or Unix stream socket in the guest over a WebSocket. |