---
title: "OS API"
description: "TypeScript 系统信息 API。"
---


> 在 TypeScript 中读取非持久操作系统和宿主应用信息。

## 模块边界

`KSM.os` 封装 OS 插件，只返回平台、架构、版本、语言、时区和宿主应用版本。它不读取
设备标识、主机名、用户名或真实文件路径。

实现入口是 `frontend/src/api/os.ts`。调用不需要业务参数，但需要 `os.info` 权限。

## 平台支持

| 能力 | Windows | Android |
| --- | --- | --- |
| `os.getInfo` | 支持 | 支持 |

## 方法

```ts
const info = await KSM.os.getInfo();
console.info(info.platform, info.version, info.appVersion);
```

| 字段 | 类型 |
| --- | --- |
| `platform` | `windows` / `android` |
| `architecture` | string |
| `version` | string |
| `locale` | string |
| `timezone` | string |
| `appVersion` | string |

## 隐私边界

- 返回值不能作为用户身份或持久设备标识。
- 不返回 Android ID、IMEI、序列号、广告 ID、主机名或用户名。
- 需要 Android 设备型号、屏幕尺寸和密度时使用 `KSM.device.getInfo()`。

## 错误行为

| 错误码 | 场景 |
| --- | --- |
| `PERMISSION_DENIED` | 没有 `os.info` 权限 |
| `NOT_SUPPORTED` | 宿主未注册 OS 插件或系统信息服务不可用 |
| `TIMEOUT` / `CANCELLED` | 请求被超时或取消 |

## 相关

- [OS 插件规则](/docs/kasumi/plugins/os)
- [设备 API](/docs/kasumi/api/device)
- [共享类型](/docs/kasumi/api/types)

## 排查路径

1. 确认 `capabilities.query` 返回 `os.getInfo`。
2. 确认宿主注册了 OS 插件和系统信息服务。
3. 确认应用 allowlist 包含命令。