# AI & LLMS (/docs/ai-docs)



本站基于 [Fumadocs](https://www.fumadocs.dev/docs/integrations/llms) 提供多种 **AI 可读** 格式，方便大模型、IDE 插件或自动化脚本直接获取文档内容，无需解析 HTML。

站点根地址（GitHub Pages）：

```
https://siaikin.github.io/qinglong-client/
```

***

## 三种获取方式 [#三种获取方式]

| 方式              | 地址               | 适用场景                         |
| --------------- | ---------------- | ---------------------------- |
| **文档索引**        | `/llms.txt`      | 让 AI 先了解有哪些页面，再按需读取          |
| **全文合集**        | `/llms-full.txt` | 一次性喂给 AI，适合离线分析或 RAG 入库      |
| **单页 Markdown** | `/docs/{路径}.md`  | 只读某一章，或配合页面上的 Copy / Open 按钮 |

完整 URL 示例：

* [llms.txt](https://siaikin.github.io/qinglong-client/llms.txt)
* [llms-full.txt](https://siaikin.github.io/qinglong-client/llms-full.txt)
* [快速入门 Markdown](https://siaikin.github.io/qinglong-client/docs/getting-started.md)
* [client.envs API Markdown](https://siaikin.github.io/qinglong-client/docs/api/envs.md)

***

## llms.txt [#llmstxt]

[`llms.txt`](https://llmstxt.org/) 是一种约定：在站点根路径放置纯文本索引，列出文档标题、简介与链接，供 AI 爬虫或 Agent 发现内容结构。

本站 `llms.txt` 由文档目录树自动生成，格式大致如下：

```markdown
# 文档

- [快速入门](/docs/getting-started.md): 安装、认证、配置与基础用法
- API 参考
  - [client.envs](/docs/api/envs.md): 环境变量 API
  ...
```

索引中的链接均指向 `*.md` 端点，AI 可直接 fetch 获取 Markdown 正文。

**用法示例** — 在对话中告诉 AI：

> 请先阅读 [https://siaikin.github.io/qinglong-client/llms.txt](https://siaikin.github.io/qinglong-client/llms.txt) 了解文档结构，再根据需要打开具体页面。

或在终端拉取索引：

```bash
curl -s https://siaikin.github.io/qinglong-client/llms.txt
```

***

## llms-full.txt [#llms-fulltxt]

`llms-full.txt` 将 **所有文档页面** 的 Markdown 合并为单个文件，页面之间以空行分隔。适合：

* 需要「整站上下文」的一次性问答
* 导入向量数据库做 RAG
* 本地保存离线副本

```bash
curl -s https://siaikin.github.io/qinglong-client/llms-full.txt -o qinglong-client-docs.md
```

注意：文件体积较大（含 TypeDoc 自动生成的 API 参考），若只需指南与手写 API 表，优先用 `llms.txt` + 单页 `.md`。

***

## 单页 `*.md` [#单页-md]

任意文档页面对应的 Markdown 地址，规则为：**在页面 URL 后加 `.md`**。

| 页面         | HTML                    | Markdown                   |
| ---------- | ----------------------- | -------------------------- |
| 文档首页       | `/docs`                 | `/docs/index.md`           |
| 快速入门       | `/docs/getting-started` | `/docs/getting-started.md` |
| envs 模块    | `/docs/api/envs`        | `/docs/api/envs.md`        |
| TypeDoc 入口 | `/docs/reference`       | `/docs/reference.md`       |

```bash
# 获取快速入门的 Markdown
curl -s https://siaikin.github.io/qinglong-client/docs/getting-started.md

# 获取 crons API 参考
curl -s https://siaikin.github.io/qinglong-client/docs/api/crons.md
```

内容为 MDX 编译后的纯 Markdown（表格、代码块、标题层级均保留），文件头包含页面标题与原始 URL。

***

## 文档页内按钮 [#文档页内按钮]

每一篇文档标题下方提供两个操作（由 Fumadocs 内置）：

* **Copy Markdown** — 从对应 `.md` 地址拉取内容并复制到剪贴板
* **Open** — 快捷打开：
  * GitHub 源码
  * View as Markdown（同上 `.md` 地址）
  * ChatGPT、Claude、Cursor、Scira AI 等（将当前页 URL 填入预设提示）

在 Cursor / VS Code 中阅读文档时，可直接点 **Open in Cursor**，将当前章节作为上下文发起提问。

***

## 在 AI 工具中的推荐用法 [#在-ai-工具中的推荐用法]

### 问某一模块怎么用 [#问某一模块怎么用]

1. 打开 [llms.txt](https://siaikin.github.io/qinglong-client/llms.txt) 或目标页的 `.md` 链接
2. 将 Markdown 内容粘贴到对话，或让 AI 通过 URL 读取（若工具支持联网）
3. 结合你的实际代码提问

示例提示词：

```text
以下是 qinglong-client 的 envs API 文档：
https://siaikin.github.io/qinglong-client/docs/api/envs.md

请根据文档，帮我写一个批量导入环境变量的脚本。
```

### 让 Agent 自主检索 [#让-agent-自主检索]

```text
qinglong-client 文档索引：https://siaikin.github.io/qinglong-client/llms.txt
需要查 API 时，请读取对应 /docs/.../*.md 页面，不要猜测接口路径。
```

### 本地 RAG / 知识库 [#本地-rag--知识库]

1. 下载 `llms-full.txt` 或按需批量抓取 `*.md`
2. 切块入库
3. 检索时优先命中官方文档，避免模型幻觉出错误的 scope 或路径

***

## 与 HTML 文档的关系 [#与-html-文档的关系]

| 格式                        | 内容来源              | 说明               |
| ------------------------- | ----------------- | ---------------- |
| HTML 页面                   | 同一份 MDX           | 人类阅读、站内搜索、侧边栏导航  |
| `*.md`                    | 同一份 MDX 的后处理结果    | 机器阅读，与 HTML 同步更新 |
| TypeDoc `/docs/reference` | `src/` JSDoc 自动生成 | 类、接口、枚举的详细类型说明   |

手写 [API 参考](/docs/api) 侧重 **HTTP 方法表与示例**；[TypeDoc](/docs/reference) 侧重 **类型签名与 JSDoc 注释**。AI 场景下可按需组合使用。

***

## 本地开发 [#本地开发]

本地启动文档站后，同样支持上述端点（无 `/qinglong-client` 前缀）：

```bash
pnpm docs:dev
```

| 端点            | 本地地址                                                                                           |
| ------------- | ---------------------------------------------------------------------------------------------- |
| llms.txt      | [http://localhost:3000/llms.txt](http://localhost:3000/llms.txt)                               |
| llms-full.txt | [http://localhost:3000/llms-full.txt](http://localhost:3000/llms-full.txt)                     |
| 单页 Markdown   | [http://localhost:3000/docs/getting-started.md](http://localhost:3000/docs/getting-started.md) |

构建静态站点时，`.md` 文件会写入 `website/out/docs/`，随 GitHub Pages 一并部署。


# 常见问题 (/docs/faq)



## 认证相关 [#认证相关]

### 如何获取 client\_id 和 client\_secret？ [#如何获取-client_id-和-client_secret]

在青龙面板 **系统设置 → 应用设置 → 添加应用** 中创建，创建后可在应用列表中查看。`client_secret` 可通过「重置密钥」重新生成。

### Token 有效期多久？ [#token-有效期多久]

默认 **30 天**。客户端在过期前 5 分钟自动刷新，无需手动处理。

### 收到 401 错误怎么办？ [#收到-401-错误怎么办]

可能原因：

1. **Token 过期** — 客户端会自动刷新，若持续失败请检查 `client_id` / `client_secret` 是否正确
2. **Scope 不匹配** — 确认应用在面板中勾选了对应权限（如调用 `client.envs` 需 `envs` scope）
3. **路径大小写** — 青龙启用了严格路由，路径必须小写（如 `/open/envs`，非 `/open/Envs`）

### 应用管理接口（/open/apps）能用吗？ [#应用管理接口openapps能用吗]

不能。`/open/apps*` 属于面板 JWT 管理接口，不在 Open API scope 内。本客户端不包含这些接口。

***

## 配置相关 [#配置相关]

### baseUrl 怎么填？ [#baseurl-怎么填]

| 场景                | baseUrl 示例                  |
| ----------------- | --------------------------- |
| 默认安装              | `http://localhost:5700`     |
| 自定义端口             | `http://192.168.1.100:8888` |
| 配置了 QlBaseUrl=/ql | `http://localhost:5700/ql`  |
| 反向代理              | `https://ql.example.com`    |

注意：**不要**在 baseUrl 末尾加 `/open`，客户端会自动拼接。

### 如何在 Docker 环境中使用？ [#如何在-docker-环境中使用]

```typescript
const client = new QinglongClient({
  baseUrl: 'http://host.docker.internal:5700',
  clientId: process.env.QL_CLIENT_ID!,
  clientSecret: process.env.QL_CLIENT_SECRET!,
});
```

***

## 接口使用 [#接口使用]

### 批量操作的 ID 格式 [#批量操作的-id-格式]

DELETE、PUT 等批量接口的 body 为 **ID 数组**：

```typescript
await client.envs.delete([1, 2, 3]);     // 正确
await client.crons.run([42]);             // 单个也传数组
await client.envs.delete(1);             // 错误：不要传单个数字
```

### 环境变量命名规则 [#环境变量命名规则]

变量名必须以字母或下划线开头，仅含字母、数字、下划线：

```
✅ JD_COOKIE, _private, my_var2
❌ 123_VAR, my-var, JD COOKIE
```

### Cron 表达式格式 [#cron-表达式格式]

支持标准 5 位 cron 表达式和特殊值：

```
0 8 * * *     # 每天 8:00
*/5 * * * *   # 每 5 分钟
@once         # 仅运行一次
@boot         # 启动时运行
```

### 如何按名称查找定时任务？ [#如何按名称查找定时任务]

**不要**使用 `GET /open/crons/detail?name=…`（源码中 `/crons/detail` 仅支持 `log_path`）。应使用列表接口：

```typescript
// 模糊搜索
const { data, total } = await client.crons.list({ searchValue: '签到' });

// 按名称字段搜索
const { data } = await client.crons.list({ searchValue: 'name:每日签到' });
```

`list()` 返回 `{ data: Crontab[], total: number }`，不是裸数组。

### 流式接口如何使用？ [#流式接口如何使用]

`commandRun`、`getLog`、`updateNodeMirror` 等接口在服务端以流式返回。客户端自动收集完整文本后返回 `Promise<string>`，适合大多数场景。若需实时处理流，可使用自定义 `fetch` 直接请求 `/open/system/command-run`。

### 下载接口返回什么？ [#下载接口返回什么]

`scripts.download()` 和 `logs.download()` 返回 `Promise<Blob>`：

```typescript
const blob = await client.scripts.download({ filename: 'test.js' });
const text = await blob.text();                          // 文本内容
const buffer = Buffer.from(await blob.arrayBuffer());    // Node.js 二进制
```

***

## 类型与版本 [#类型与版本]

### 类型从哪里来？ [#类型从哪里来]

从青龙源码手工推导，非 OpenAPI codegen：

* 实体类型 ← `back/data/*.ts`
* 请求类型 ← `back/api/*.ts` Joi 校验
* 注释 ← Joi 错误消息 + 枚举说明

### 如何跟进青龙版本更新？ [#如何跟进青龙版本更新]

1. 查看 `package.json` 的 `qinglongVersion` 字段
2. 对比青龙 `back/api/` 路由变更
3. 更新本客户端 `src/types/` 和 `src/apis/`
4. 发布新版本

### 类型能在浏览器中使用吗？ [#类型能在浏览器中使用吗]

可以。包同时输出 ESM 和 CJS，支持 Node.js 18+ 和现代 bundler（Vite、Webpack 等）。浏览器环境需解决跨域（CORS）问题，通常通过反向代理访问青龙面板。

***

## 与面板内置 API 的区别 [#与面板内置-api-的区别]

|      | Open API (`/open/*`) | 内置 API (QLAPI/gRPC) |
| ---- | -------------------- | ------------------- |
| 协议   | REST/HTTP            | gRPC                |
| 鉴权   | 应用 Token + scope     | 脚本内建，无需配置           |
| 使用场景 | 外部系统集成               | 脚本运行时调用             |
| 本客户端 | ✅ 支持                 | ❌ 不支持               |

内置 API 文档：[qinglong.online 内置 API](https://qinglong.online/guide/user-guide/built-in-api)


# 快速入门 (/docs/getting-started)



## 什么是 Open API [#什么是-open-api]

青龙面板的 Open API 是一组面向第三方集成的 REST 接口，基础路径为 `/open/*`。与面板内部使用的 `/api/*` 接口共享同一套路由，但鉴权方式不同：

* **Open API**：使用应用 `client_id` / `client_secret` 换取 Bearer Token，按 scope 控制权限
* **面板 API**：使用用户登录后的 JWT Token，拥有完整管理权限

本客户端仅覆盖 **Open API**（`/open/*`），不包含 `/open/apps*` 等需要面板 JWT 的应用管理接口。

## 准备工作 [#准备工作]

### 1. 创建应用 [#1-创建应用]

在青龙面板中：**系统设置 → 应用设置 → 添加应用**

记录生成的：

* `client_id`（12 位随机字符串）
* `client_secret`（24 位随机字符串）

### 2. 配置权限（Scope） [#2-配置权限scope]

创建应用时勾选所需权限，调用接口时路径第一段必须与 scope 匹配：

| Scope           | 路径前缀                  | 说明   |
| --------------- | --------------------- | ---- |
| `envs`          | `/open/envs`          | 环境变量 |
| `crons`         | `/open/crons`         | 定时任务 |
| `subscriptions` | `/open/subscriptions` | 订阅管理 |
| `configs`       | `/open/configs`       | 配置文件 |
| `scripts`       | `/open/scripts`       | 脚本管理 |
| `logs`          | `/open/logs`          | 日志管理 |
| `dependencies`  | `/open/dependencies`  | 依赖管理 |
| `system`        | `/open/system`        | 系统设置 |

若应用未授权对应 scope，请求将返回 `401`。

### 3. 确认面板地址 [#3-确认面板地址]

默认端口 `5700`，完整地址示例：

```
http://localhost:5700
http://192.168.1.100:5700
```

若配置了 `QlBaseUrl`（如 `/ql`），需包含前缀：

```
http://localhost:5700/ql
```

## 安装 [#安装]

```bash
pnpm add qinglong-client
# 或
npm install qinglong-client
```

要求 **Node.js >= 18**（使用原生 `fetch`）。

## 创建客户端 [#创建客户端]

```typescript
import { QinglongClient } from 'qinglong-client';

const client = new QinglongClient({
  baseUrl: 'http://localhost:5700',
  clientId: 'your_client_id',
  clientSecret: 'your_client_secret',
});
```

### 配置项 [#配置项]

| 字段                   | 类型             | 必填 | 说明                      |
| -------------------- | -------------- | -- | ----------------------- |
| `baseUrl`            | `string`       | 是  | 面板地址，支持 `QlBaseUrl` 前缀  |
| `clientId`           | `string`       | 是  | 应用 Client ID            |
| `clientSecret`       | `string`       | 是  | 应用 Client Secret        |
| `fetch`              | `typeof fetch` | 否  | 自定义 fetch，可用于代理或测试      |
| `tokenRefreshBuffer` | `number`       | 否  | Token 过期前刷新缓冲（秒），默认 300 |

## 认证机制 [#认证机制]

客户端自动处理 Token 生命周期，无需手动管理：

1. 首次请求时调用 `GET /open/auth/token?client_id=...&client_secret=...`
2. 缓存返回的 Bearer Token（默认有效期 30 天）
3. 在过期前 5 分钟（可配置）自动刷新
4. 后续请求自动携带 `Authorization: Bearer <token>`

Token 响应结构：

```typescript
interface AuthToken {
  token: string;
  token_type: 'Bearer';
  expiration: number; // Unix 秒级时间戳
}
```

## 基础用法 [#基础用法]

### 环境变量 [#环境变量]

```typescript
// 列表
const envs = await client.envs.list({ searchValue: 'JD' });

// 创建（批量）
await client.envs.create([
  { name: 'JD_COOKIE', value: 'xxx', remarks: '京东 Cookie' },
]);

// 更新
await client.envs.update({
  id: 1,
  name: 'JD_COOKIE',
  value: 'new_value',
});

// 删除
await client.envs.delete([1, 2, 3]);
```

### 定时任务 [#定时任务]

```typescript
// 创建
const cron = await client.crons.create({
  name: '每日签到',
  command: 'task sign.js',
  schedule: '0 8 * * *',
});

// 运行
await client.crons.run([cron.id!]);

// 查询日志
const log = await client.crons.getLog(cron.id!);
```

### 系统通知 [#系统通知]

```typescript
await client.system.notify({
  title: '任务完成',
  content: '签到脚本执行成功',
});
```

### 系统信息（无需鉴权） [#系统信息无需鉴权]

```typescript
const info = await client.system.info();
console.log(info.version, info.branch);
```

## 响应与错误 [#响应与错误]

所有接口返回统一格式 `{ code, data, message }`。客户端在 `code !== 200` 时抛出 `QinglongApiError`：

```typescript
import { QinglongApiError } from 'qinglong-client';

try {
  await client.envs.create([{ name: '123INVALID', value: 'x' }]);
} catch (e) {
  if (e instanceof QinglongApiError) {
    console.error('错误码:', e.code);
    console.error('消息:', e.message);
    console.error('校验详情:', e.errors);
  }
}
```

常见错误码：

| code  | 含义                          |
| ----- | --------------------------- |
| `200` | 成功                          |
| `400` | 参数错误（Joi 校验失败）              |
| `401` | 未授权（Token 无效、过期或 scope 不匹配） |
| `403` | 无权限（文件路径等）                  |

## 特殊接口 [#特殊接口]

### Multipart 上传 [#multipart-上传]

```typescript
import { readFileSync } from 'fs';

// 上传环境变量 JSON
const file = new Blob([readFileSync('envs.json')]);
await client.envs.upload(file);

// 导入数据备份
await client.system.importData(file);
```

### 二进制下载 [#二进制下载]

```typescript
const blob = await client.scripts.download({
  filename: 'sign.js',
  path: 'repo',
});

// 保存到本地（Node.js）
import { writeFileSync } from 'fs';
writeFileSync('sign.js', Buffer.from(await blob.arrayBuffer()));
```

### 流式文本 [#流式文本]

以下接口返回完整文本（客户端自动收集流式响应）：

```typescript
const output = await client.system.commandRun({ command: 'node sign.js' });
const sysLog = await client.system.getLog({ startTime: '2024-01-01' });
```

## 与青龙版本同步 [#与青龙版本同步]

`package.json` 中的 `qinglongVersion` 字段标明本客户端对应的青龙版本。青龙 API 变更时需同步更新客户端类型与接口。

当前对应版本：**2.20.2**


# 文档首页 (/docs)



qinglong-client 完整文档。

在线阅读：&#x2A;*[https://siaikin.github.io/qinglong-client/](https://siaikin.github.io/qinglong-client/)**

## 目录 [#目录]

### 指南文档 [#指南文档]

| 文档                            | 说明                               |
| ----------------------------- | -------------------------------- |
| [快速入门](/docs/getting-started) | 安装、认证、配置、基础用法                    |
| [API 参考](/docs/api)           | 8 个模块全部方法（105+ 端点）               |
| [TypeDoc](/docs/reference)    | 从源码 JSDoc 自动生成（顶部导航入口）           |
| [类型参考](/docs/types)           | TypeScript 类型与枚举说明               |
| [AI & LLMS](/docs/ai-docs)    | llms.txt、单页 Markdown、在 AI 工具中的用法 |
| [常见问题](/docs/faq)             | 认证、配置、批量操作、版本同步                  |

## 架构概览 [#架构概览]

```
QinglongClient
├── envs           → /open/envs          (scope: envs)
├── crons          → /open/crons         (scope: crons)
├── subscriptions  → /open/subscriptions (scope: subscriptions)
├── configs        → /open/configs       (scope: configs)
├── scripts        → /open/scripts       (scope: scripts)
├── logs           → /open/logs          (scope: logs)
├── dependencies   → /open/dependencies  (scope: dependencies)
└── system         → /open/system        (scope: system)
```

认证流程：

```
client_id + client_secret
        ↓
GET /open/auth/token
        ↓
Bearer Token（自动缓存，过期前刷新）
        ↓
Authorization: Bearer <token>
        ↓
GET/POST/PUT/DELETE /open/{scope}/...
```

## 相关链接 [#相关链接]

* [青龙面板](https://github.com/whyour/qinglong)
* [青龙官方 API 文档](https://qinglong.online/api/)
* [内置 API（QLAPI/gRPC）](https://qinglong.online/guide/user-guide/built-in-api)


# 类型参考 (/docs/types)



完整类型定义见 &#x2A;*[TypeDoc](/docs/reference)**（自动生成）及下方速查。

所有类型均可从包中直接导入，IDE 悬停可查看 JSDoc 中文注释。

```typescript
import type { Env, Crontab, QinglongClientOptions } from 'qinglong-client';
```

类型定义从青龙源码（`back/data/*.ts`、`back/api/*.ts` Joi 校验）手工推导，对应青龙版本 **2.20.2**。

***

## 通用类型 [#通用类型]

### QinglongClientOptions [#qinglongclientoptions]

客户端构造参数。

```typescript
interface QinglongClientOptions {
  baseUrl: string;           // 面板地址，支持 QlBaseUrl 前缀
  clientId: string;          // 应用 Client ID
  clientSecret: string;      // 应用 Client Secret
  fetch?: typeof fetch;      // 自定义 fetch
  tokenRefreshBuffer?: number; // Token 刷新缓冲（秒），默认 300
}
```

### QinglongResponse [#qinglongresponse]

青龙统一 API 响应格式（泛型 `T` 为 `data` 字段类型）。

```typescript
interface QinglongResponse<T = unknown> {
  code: number;    // 200 = 成功
  data?: T;
  message?: string;
  errors?: Array<{ message: string; value?: unknown }>;
}
```

### QinglongApiError [#qinglongapierror]

`code !== 200` 时抛出的错误类。

```typescript
class QinglongApiError extends Error {
  readonly code: number;
  readonly errors?: QinglongResponse['errors'];
}
```

### AppScope [#appscope]

应用权限范围。

```typescript
type AppScope =
  | 'crons' | 'envs' | 'subscriptions' | 'configs'
  | 'scripts' | 'logs' | 'dependencies' | 'system' | 'dashboard';
```

***

## 认证 [#认证]

```typescript
interface AuthToken {
  token: string;
  token_type: 'Bearer';
  expiration: number; // Unix 秒，默认 30 天
}
```

***

## 环境变量 [#环境变量]

```typescript
enum EnvStatus { Normal = 0, Disabled = 1 }

interface Env {
  id?: number;
  name?: string;       // 字母/下划线开头
  value?: string;
  remarks?: string;
  status?: EnvStatus;
  position?: number;
  isPinned?: 0 | 1;
  labels?: string[];
}

interface CreateEnvItem {
  name: string;        // 正则: /^[a-zA-Z_][0-9a-zA-Z_]*$/
  value: string;
  remarks?: string;
  labels?: string[];
}

interface UpdateEnvRequest {
  id: number;
  name: string;
  value: string;
  remarks?: string | null;
  labels?: string[];
}
```

***

## 定时任务 [#定时任务]

```typescript
enum CrontabStatus { Running = 0, Idle = 1, Disabled = 2, Queued = 3 }
enum InstanceStatus { Running = 0, Finished = 1, Stopped = 2, Error = 3 }

interface CronMutationRequest {
  name?: string;
  command: string;              // 必填
  schedule: string;             // cron 表达式或 @once / @boot
  labels?: string[];
  sub_id?: number | null;
  extra_schedules?: Array<{ schedule: string }> | null;
  task_before?: string | null;
  task_after?: string | null;
  log_name?: string | null;
  allow_multiple_instances?: 0 | 1 | null;
  work_dir?: string | null;
}

interface UpdateCronRequest extends CronMutationRequest {
  id: number;
}

interface Crontab extends CronMutationRequest {
  id?: number;
  status?: CrontabStatus;
  isDisabled?: 0 | 1;
  isPinned?: 0 | 1;
  pid?: number;
  log_path?: string;
  last_running_time?: number;
  last_execution_time?: number;
}

interface ListCronsResult {
  data: Crontab[];
  total: number;
}

interface ListCronsQuery {
  searchValue?: string;   // 纯文本或 name:xxx / command:xxx / schedule:xxx / label:xxx
  page?: string;
  size?: string;
  sorter?: string;        // JSON 字符串
  filters?: string;       // JSON 字符串
  queryString?: string;   // 视图 JSON 字符串
}

interface CronDetailQuery {
  log_path: string;       // 仅此参数，不支持 name/command/schedule
}

interface RunningInstance {
  id?: number;
  cron_id: number;
  pid?: number;
  log_path?: string;
  started_at: number;
  finished_at?: number;
  status: InstanceStatus;
  exit_code?: number;
}

interface CronView {
  id?: number;
  name?: string;
  filters?: CronViewFilter[];
  sorts?: CronViewSort[] | null;
  filterRelation?: 'and' | 'or';
  type?: 1 | 2;  // 1=系统, 2=个人
}
```

***

## 订阅 [#订阅]

```typescript
enum SubscriptionStatus { Running = 0, Idle = 1, Disabled = 2, Queued = 3 }

type SubscriptionType = 'public-repo' | 'private-repo' | 'file';
type ScheduleType = 'crontab' | 'interval';
type PullType = 'ssh-key' | 'user-pwd';

interface Subscription {
  id?: number;
  type?: SubscriptionType;
  url?: string;
  alias: string;
  schedule_type?: ScheduleType;
  schedule?: string;
  status?: SubscriptionStatus;
  is_disabled?: 0 | 1;
  autoAddCron?: 0 | 1;
  autoDelCron?: 0 | 1;
  // ...
}

interface CreateSubscriptionRequest {
  type: string;
  url: string;
  alias: string;
  schedule_type: string;
  schedule?: string | null;
  // ...
}
```

***

## 依赖 [#依赖]

```typescript
enum DependenceStatus {
  Installing = 0, Installed = 1, InstallFailed = 2,
  Removing = 3, Removed = 4, RemoveFailed = 5,
  Queued = 6, Cancelled = 7,
}

enum DependenceType { Nodejs = 0, Python3 = 1, Linux = 2 }

interface Dependence {
  id?: number;
  name: string;
  type: DependenceType;
  status: DependenceStatus;
  remark?: string;
  log?: string[];
}

interface CreateDependenceItem {
  name: string;
  type: DependenceType;
  remark?: string;
}
```

***

## 系统 [#系统]

```typescript
interface SystemInfo {
  isInitialized: boolean;
  version: string;
  publishTime: number;
  branch: string;
  changeLog: string;
  changeLogLink: string;
}

interface SystemConfig {
  logRemoveFrequency?: number;
  cronConcurrency?: number;
  dependenceProxy?: string;
  nodeMirror?: string;
  pythonMirror?: string;
  linuxMirror?: string;
  timezone?: string;
  globalSshKey?: string;
  lang?: string;
}

interface NotifyRequest {
  title: string;
  content: string;
}
```

***

## 文件树 [#文件树]

脚本和日志目录共用的文件树节点：

```typescript
interface FileNode {
  title: string;
  key: string;
  type: 'directory' | 'file';
  parent: string;
  createTime: number;
  size?: number;
  children?: FileNode[];
}
```

***

## 配置文件 [#配置文件]

```typescript
interface ConfigFileItem {
  title: string;
  value: string;
}

interface SaveConfigRequest {
  name: string;
  content?: string;
}
```


# client.configs (/docs/client-test/configs)



需要 scope：`configs`

<ClientModuleTester module="configs" />


# client.crons (/docs/client-test/crons)



需要 scope：`crons`

<ClientModuleTester module="crons" />


# client.dependencies (/docs/client-test/dependencies)



需要 scope：`dependencies`

<ClientModuleTester module="dependencies" />


# client.envs (/docs/client-test/envs)



需要 scope：`envs`

<ClientModuleTester module="envs" />


# 连接配置 (/docs/client-test)



<Callout type="warn">
  此工具会直连你的青龙面板执行真实 API 调用。开发环境下，请求经本站 `/qinglong-proxy` 转发至下方填写的真实面板地址（含 `/ql` 前缀时照常填写），可绕过浏览器 CORS。生产环境（静态部署）无代理，需面板允许跨域或通过反向代理同域部署。请确保应用已授权对应 scope；部分接口会产生副作用。
</Callout>

填写下方表单，配置保存在浏览器 localStorage，不会上传到服务器。

<ClientConnectionForm />

## 模块测试 [#模块测试]

选择模块进入对应 API 测试页面：

<Cards>
  <Card title="client.envs" href="/docs/client-test/envs" description="环境变量，需要 envs scope" />

  <Card title="client.crons" href="/docs/client-test/crons" description="定时任务，需要 crons scope" />

  <Card title="client.subscriptions" href="/docs/client-test/subscriptions" description="订阅管理，需要 subscriptions scope" />

  <Card title="client.configs" href="/docs/client-test/configs" description="配置文件，需要 configs scope" />

  <Card title="client.scripts" href="/docs/client-test/scripts" description="脚本管理，需要 scripts scope" />

  <Card title="client.logs" href="/docs/client-test/logs" description="日志管理，需要 logs scope" />

  <Card title="client.dependencies" href="/docs/client-test/dependencies" description="依赖管理，需要 dependencies scope" />

  <Card title="client.system" href="/docs/client-test/system" description="系统设置，部分接口无需 scope" />
</Cards>


# client.logs (/docs/client-test/logs)



需要 scope：`logs`

<ClientModuleTester module="logs" />


# client.scripts (/docs/client-test/scripts)



需要 scope：`scripts`

<ClientModuleTester module="scripts" />


# client.subscriptions (/docs/client-test/subscriptions)



需要 scope：`subscriptions`

<ClientModuleTester module="subscriptions" />


# client.system (/docs/client-test/system)



部分接口（如 `info`）无需鉴权，其余需要 `system` scope。

<ClientModuleTester module="system" />


# client.configs (/docs/api/configs)



需要 scope：`configs`

| 方法                 | HTTP | 路径                 | 说明               |
| ------------------ | ---- | ------------------ | ---------------- |
| `listSamples()`    | GET  | `/configs/samples` | 示例配置列表           |
| `listFiles()`      | GET  | `/configs/files`   | 配置文件列表           |
| `getDetail(query)` | GET  | `/configs/detail`  | 读取配置（query.path） |
| `getFile(file)`    | GET  | `/configs/:file`   | 按文件名读取           |
| `save(body)`       | POST | `/configs/save`    | 保存配置文件           |

```typescript
const files = await client.configs.listFiles();
const content = await client.configs.getFile('config.sh');
await client.configs.save({ name: 'config.sh', content: '# ...' });
```


# client.crons (/docs/api/crons)



需要 scope：`crons`

## 定时任务 [#定时任务]

| 方法                                 | HTTP   | 路径                                      | 说明                             |
| ---------------------------------- | ------ | --------------------------------------- | ------------------------------ |
| `list(query?)`                     | GET    | `/crons`                                | 获取任务列表（返回 `{ data, total }`）   |
| `detail(query)`                    | GET    | `/crons/detail`                         | 按 **log\_path** 查询单个（不支持 name） |
| `getById(id)`                      | GET    | `/crons/:id`                            | 按 ID 获取                        |
| `create(body)`                     | POST   | `/crons`                                | 创建任务                           |
| `update(body)`                     | PUT    | `/crons`                                | 更新任务                           |
| `delete(ids)`                      | DELETE | `/crons`                                | 批量删除                           |
| `run(ids)`                         | PUT    | `/crons/run`                            | 运行任务                           |
| `stop(ids)`                        | PUT    | `/crons/stop`                           | 停止任务                           |
| `disable(ids)`                     | PUT    | `/crons/disable`                        | 禁用                             |
| `enable(ids)`                      | PUT    | `/crons/enable`                         | 启用                             |
| `pin(ids)`                         | PUT    | `/crons/pin`                            | 置顶                             |
| `unpin(ids)`                       | PUT    | `/crons/unpin`                          | 取消置顶                           |
| `updateStatus(body)`               | PUT    | `/crons/status`                         | 更新运行状态                         |
| `addLabels(body)`                  | POST   | `/crons/labels`                         | 添加标签                           |
| `removeLabels(body)`               | DELETE | `/crons/labels`                         | 移除标签                           |
| `import()`                         | GET    | `/crons/import`                         | 从 crontab 文件导入                 |
| `getLog(id)`                       | GET    | `/crons/:id/log`                        | 获取当前日志                         |
| `getLogs(id)`                      | GET    | `/crons/:id/logs`                       | 获取日志文件列表                       |
| `getInstances(id)`                 | GET    | `/crons/:id/instances`                  | 获取运行实例                         |
| `stopInstance(cronId, instanceId)` | POST   | `/crons/:id/instances/:instanceId/stop` | 停止实例                           |

### list 查询参数 [#list-查询参数]

| 参数              | 说明                                                                                             |
| --------------- | ---------------------------------------------------------------------------------------------- |
| `searchValue`   | 搜索词。纯文本模糊匹配 name/command/schedule/labels；或 `name:xxx`、`command:xxx`、`schedule:xxx`、`label:xxx` |
| `page` / `size` | 分页（page 从 1 开始）                                                                                |
| `sorter`        | 排序，JSON 字符串，如 `{"field":"name","type":"ASC"}`                                                  |
| `filters`       | 筛选，JSON 字符串                                                                                    |
| `queryString`   | 视图筛选/排序，JSON 字符串                                                                               |

```typescript
// 按名称搜索（正确方式，非 /crons/detail?name=）
const { data, total } = await client.crons.list({ searchValue: '每日签到' });
const { data: exact } = await client.crons.list({ searchValue: 'name:每日签到' });

// 按 log_path（/crons/detail 唯一支持的 query）
const byLog = await client.crons.detail({ log_path: 'xxx/yyy' });

// 按 ID
const byId = await client.crons.getById(42);
```

```typescript
// 创建示例
await client.crons.create({
  name: '测试任务',
  command: 'node test.js',
  schedule: '0 0 * * *',       // 标准 cron，或 @once / @boot
  labels: ['daily'],
  sub_id: null,
  allow_multiple_instances: 0,
});
```

## 视图 [#视图]

| 方法                  | HTTP   | 路径                     | 说明   |
| ------------------- | ------ | ---------------------- | ---- |
| `listViews()`       | GET    | `/crons/views`         | 视图列表 |
| `createView(body)`  | POST   | `/crons/views`         | 创建视图 |
| `updateView(body)`  | PUT    | `/crons/views`         | 更新视图 |
| `deleteViews(ids)`  | DELETE | `/crons/views`         | 删除视图 |
| `moveView(body)`    | PUT    | `/crons/views/move`    | 移动视图 |
| `disableViews(ids)` | PUT    | `/crons/views/disable` | 禁用视图 |
| `enableViews(ids)`  | PUT    | `/crons/views/enable`  | 启用视图 |


# client.dependencies (/docs/api/dependencies)



需要 scope：`dependencies`

| 方法                 | HTTP   | 路径                        | 说明      |
| ------------------ | ------ | ------------------------- | ------- |
| `list(query?)`     | GET    | `/dependencies`           | 依赖列表    |
| `getById(id)`      | GET    | `/dependencies/:id`       | 按 ID 获取 |
| `create(items)`    | POST   | `/dependencies`           | 批量创建    |
| `update(body)`     | PUT    | `/dependencies`           | 更新      |
| `delete(ids)`      | DELETE | `/dependencies`           | 删除      |
| `forceDelete(ids)` | DELETE | `/dependencies/force`     | 强制删除    |
| `reinstall(ids)`   | PUT    | `/dependencies/reinstall` | 重新安装    |
| `cancel(ids)`      | PUT    | `/dependencies/cancel`    | 取消安装    |

```typescript
// type: 0=nodejs, 1=python3, 2=linux
await client.dependencies.create([
  { name: 'axios', type: 0, remark: 'HTTP 库' },
]);
```


# client.envs (/docs/api/envs)



需要 scope：`envs`

| 方法                   | HTTP   | 路径               | 说明                             |
| -------------------- | ------ | ---------------- | ------------------------------ |
| `list(query?)`       | GET    | `/envs`          | 获取环境变量列表                       |
| `getById(id)`        | GET    | `/envs/:id`      | 按 ID 获取                        |
| `create(items)`      | POST   | `/envs`          | 批量创建                           |
| `update(body)`       | PUT    | `/envs`          | 更新单个                           |
| `delete(ids)`        | DELETE | `/envs`          | 批量删除，body 为 ID 数组              |
| `move(id, body)`     | PUT    | `/envs/:id/move` | 移动位置                           |
| `disable(ids)`       | PUT    | `/envs/disable`  | 批量禁用                           |
| `enable(ids)`        | PUT    | `/envs/enable`   | 批量启用                           |
| `updateNames(body)`  | PUT    | `/envs/name`     | 批量重命名                          |
| `pin(ids)`           | PUT    | `/envs/pin`      | 置顶                             |
| `unpin(ids)`         | PUT    | `/envs/unpin`    | 取消置顶                           |
| `addLabels(body)`    | POST   | `/envs/labels`   | 添加标签                           |
| `removeLabels(body)` | DELETE | `/envs/labels`   | 移除标签                           |
| `upload(file)`       | POST   | `/envs/upload`   | 上传 JSON 文件（multipart，字段 `env`） |

```typescript
// 创建示例
await client.envs.create([
  { name: 'MY_VAR', value: 'hello', remarks: '备注', labels: ['tag1'] },
]);
```


# API 参考概览 (/docs/api)



所有方法均在 `QinglongClient` 实例上通过子模块调用。路径均相对于 `/open`。

## 模块一览 [#模块一览]

| 模块                     | Scope           | 方法数 | 文档                              |
| ---------------------- | --------------- | --- | ------------------------------- |
| `client.envs`          | `envs`          | 14  | [环境变量](/docs/api/envs)          |
| `client.crons`         | `crons`         | 27  | [定时任务](/docs/api/crons)         |
| `client.subscriptions` | `subscriptions` | 12  | [订阅管理](/docs/api/subscriptions) |
| `client.configs`       | `configs`       | 5   | [配置文件](/docs/api/configs)       |
| `client.scripts`       | `scripts`       | 10  | [脚本管理](/docs/api/scripts)       |
| `client.logs`          | `logs`          | 5   | [日志管理](/docs/api/logs)          |
| `client.dependencies`  | `dependencies`  | 8   | [依赖管理](/docs/api/dependencies)  |
| `client.system`        | `system`        | 23  | [系统设置](/docs/api/system)        |

## 架构概览 [#架构概览]

```
QinglongClient
├── envs           → /open/envs          (scope: envs)
├── crons          → /open/crons         (scope: crons)
├── subscriptions  → /open/subscriptions (scope: subscriptions)
├── configs        → /open/configs       (scope: configs)
├── scripts        → /open/scripts       (scope: scripts)
├── logs           → /open/logs          (scope: logs)
├── dependencies   → /open/dependencies  (scope: dependencies)
└── system         → /open/system        (scope: system)
```

从源码 JSDoc 自动生成的类型级 API 文档见顶部导航 &#x2A;*[TypeDoc](/docs/reference)**。


# client.logs (/docs/api/logs)



需要 scope：`logs`

| 方法                      | HTTP   | 路径               | 说明             |
| ----------------------- | ------ | ---------------- | -------------- |
| `list()`                | GET    | `/logs`          | 日志目录树          |
| `getDetail(query)`      | GET    | `/logs/detail`   | 读取日志（ANSI 已剥离） |
| `getFile(file, query?)` | GET    | `/logs/:file`    | 按文件名读取         |
| `delete(body)`          | DELETE | `/logs`          | 删除日志文件         |
| `download(body)`        | POST   | `/logs/download` | 下载（返回 Blob）    |


# client.scripts (/docs/api/scripts)



需要 scope：`scripts`

| 方法                      | HTTP   | 路径                  | 说明          |
| ----------------------- | ------ | ------------------- | ----------- |
| `list(query?)`          | GET    | `/scripts`          | 脚本目录树       |
| `getDetail(query)`      | GET    | `/scripts/detail`   | 读取脚本内容      |
| `getFile(file, query?)` | GET    | `/scripts/:file`    | 按文件名读取      |
| `create(body)`          | POST   | `/scripts`          | 创建脚本/目录     |
| `update(body)`          | PUT    | `/scripts`          | 更新脚本内容      |
| `delete(body)`          | DELETE | `/scripts`          | 删除脚本/目录     |
| `run(body)`             | PUT    | `/scripts/run`      | 运行脚本        |
| `stop(body)`            | PUT    | `/scripts/stop`     | 停止脚本        |
| `rename(body)`          | PUT    | `/scripts/rename`   | 重命名         |
| `download(body)`        | POST   | `/scripts/download` | 下载（返回 Blob） |

```typescript
const tree = await client.scripts.list({ path: 'repo' });
const code = await client.scripts.getDetail({ path: 'repo', file: 'sign.js' });
await client.scripts.update({
  filename: 'sign.js',
  path: 'repo',
  content: 'console.log("hello")',
});
```


# client.subscriptions (/docs/api/subscriptions)



需要 scope：`subscriptions`

| 方法                    | HTTP   | 路径                        | 说明                    |
| --------------------- | ------ | ------------------------- | --------------------- |
| `list(query?)`        | GET    | `/subscriptions`          | 订阅列表                  |
| `getById(id)`         | GET    | `/subscriptions/:id`      | 按 ID 获取               |
| `create(body)`        | POST   | `/subscriptions`          | 创建订阅                  |
| `update(body)`        | PUT    | `/subscriptions`          | 更新订阅                  |
| `delete(ids, query?)` | DELETE | `/subscriptions`          | 删除，`query.force` 强制删除 |
| `run(ids)`            | PUT    | `/subscriptions/run`      | 运行                    |
| `stop(ids)`           | PUT    | `/subscriptions/stop`     | 停止                    |
| `disable(ids)`        | PUT    | `/subscriptions/disable`  | 禁用                    |
| `enable(ids)`         | PUT    | `/subscriptions/enable`   | 启用                    |
| `updateStatus(body)`  | PUT    | `/subscriptions/status`   | 更新状态                  |
| `getLog(id)`          | GET    | `/subscriptions/:id/log`  | 当前日志                  |
| `getLogs(id)`         | GET    | `/subscriptions/:id/logs` | 日志文件列表                |

```typescript
await client.subscriptions.create({
  type: 'public-repo',
  url: 'https://github.com/user/repo.git',
  alias: 'my-repo',
  schedule_type: 'crontab',
  schedule: '0 0 * * *',
});
```


# client.system (/docs/api/system)



需要 scope：`system`（`info()` 除外，无需鉴权）

## 信息与通知 [#信息与通知]

| 方法                  | HTTP | 路径                     | 说明             |
| ------------------- | ---- | ---------------------- | -------------- |
| `info()`            | GET  | `/system`              | 系统信息（**无需鉴权**） |
| `getConfig()`       | GET  | `/system/config`       | 系统配置           |
| `notify(body)`      | PUT  | `/system/notify`       | 发送通知           |
| `commandRun(body)`  | PUT  | `/system/command-run`  | 运行命令（流式文本）     |
| `commandStop(body)` | PUT  | `/system/command-stop` | 停止命令           |

## 更新与数据 [#更新与数据]

| 方法                  | HTTP   | 路径                     | 说明              |
| ------------------- | ------ | ---------------------- | --------------- |
| `checkUpdate()`     | PUT    | `/system/update-check` | 检查更新            |
| `update()`          | PUT    | `/system/update`       | 更新青龙            |
| `reload(body?)`     | PUT    | `/system/reload`       | 重载系统            |
| `exportData(body?)` | PUT    | `/system/data/export`  | 导出数据（Blob）      |
| `importData(file)`  | PUT    | `/system/data/import`  | 导入数据（multipart） |
| `getLog(query?)`    | GET    | `/system/log`          | 系统日志（流式文本）      |
| `deleteLog()`       | DELETE | `/system/log`          | 删除系统日志          |
| `resetAuth(body)`   | PUT    | `/system/auth/reset`   | 重置管理员认证         |

## 配置项 [#配置项]

| 方法                               | HTTP | 路径                                    |
| -------------------------------- | ---- | ------------------------------------- |
| `updateLogRemoveFrequency(body)` | PUT  | `/system/config/log-remove-frequency` |
| `updateCronConcurrency(body)`    | PUT  | `/system/config/cron-concurrency`     |
| `updateDependenceProxy(body)`    | PUT  | `/system/config/dependence-proxy`     |
| `updateNodeMirror(body)`         | PUT  | `/system/config/node-mirror`          |
| `updatePythonMirror(body)`       | PUT  | `/system/config/python-mirror`        |
| `updateLinuxMirror(body)`        | PUT  | `/system/config/linux-mirror`         |
| `updateTimezone(body)`           | PUT  | `/system/config/timezone`             |
| `updateLanguage(body)`           | PUT  | `/system/config/lang`                 |
| `updateGlobalSshKey(body)`       | PUT  | `/system/config/global-ssh-key`       |
| `cleanDependence(body)`          | PUT  | `/system/config/dependence-clean`     |

```typescript
const info = await client.system.info();
// { isInitialized, version, publishTime, branch, changeLog, changeLogLink }

await client.system.notify({ title: '告警', content: '磁盘空间不足' });
```


# TypeDoc (/docs/reference)



# qinglong-client API v2.0.1 [#qinglong-client-api-v201]

qinglong-client

青龙面板 Open API（/open/\*）TypeScript 客户端。

## Example [#example]

```typescript
import { QinglongClient } from 'qinglong-client';

const client = new QinglongClient({
  baseUrl: 'http://localhost:5700',
  clientId: 'xxx',
  clientSecret: 'yyy',
});

const envs = await client.envs.list();
```

## Enumerations [#enumerations]

* [CrontabStatus](enumerations/CrontabStatus)
* [InstanceStatus](enumerations/InstanceStatus)
* [DependenceStatus](enumerations/DependenceStatus)
* [DependenceType](enumerations/DependenceType)
* [EnvStatus](enumerations/EnvStatus)
* [SubscriptionStatus](enumerations/SubscriptionStatus)

## Classes [#classes]

### Client [#client]

* [QinglongClient](classes/QinglongClient)

### Other [#other]

* [QinglongApiError](classes/QinglongApiError)

## Interfaces [#interfaces]

* [AuthToken](interfaces/AuthToken)
* [AuthTokenQuery](interfaces/AuthTokenQuery)
* [QinglongResponse](interfaces/QinglongResponse)
* [QinglongClientOptions](interfaces/QinglongClientOptions)
* [RequestOptions](interfaces/RequestOptions)
* [ConfigFileItem](interfaces/ConfigFileItem)
* [ConfigDetailQuery](interfaces/ConfigDetailQuery)
* [SaveConfigRequest](interfaces/SaveConfigRequest)
* [ExtraSchedule](interfaces/ExtraSchedule)
* [CronMutationRequest](interfaces/CronMutationRequest)
* [UpdateCronRequest](interfaces/UpdateCronRequest)
* [Crontab](interfaces/Crontab)
* [ListCronsResult](interfaces/ListCronsResult)
* [ListCronsQuery](interfaces/ListCronsQuery)
* [CronDetailQuery](interfaces/CronDetailQuery)
* [UpdateCronStatusRequest](interfaces/UpdateCronStatusRequest)
* [CronLabelsRequest](interfaces/CronLabelsRequest)
* [RunningInstance](interfaces/RunningInstance)
* [CronViewSort](interfaces/CronViewSort)
* [CronViewFilter](interfaces/CronViewFilter)
* [CronView](interfaces/CronView)
* [CreateCronViewRequest](interfaces/CreateCronViewRequest)
* [UpdateCronViewRequest](interfaces/UpdateCronViewRequest)
* [MoveCronViewRequest](interfaces/MoveCronViewRequest)
* [LogFileInfo](interfaces/LogFileInfo)
* [Dependence](interfaces/Dependence)
* [ListDependenciesQuery](interfaces/ListDependenciesQuery)
* [CreateDependenceItem](interfaces/CreateDependenceItem)
* [UpdateDependenceRequest](interfaces/UpdateDependenceRequest)
* [Env](interfaces/Env)
* [CreateEnvItem](interfaces/CreateEnvItem)
* [UpdateEnvRequest](interfaces/UpdateEnvRequest)
* [ListEnvsQuery](interfaces/ListEnvsQuery)
* [MoveEnvRequest](interfaces/MoveEnvRequest)
* [UpdateEnvNamesRequest](interfaces/UpdateEnvNamesRequest)
* [EnvLabelsRequest](interfaces/EnvLabelsRequest)
* [FileNode](interfaces/FileNode)
* [FilePathRequest](interfaces/FilePathRequest)
* [LogDetailQuery](interfaces/LogDetailQuery)
* [LogFileQuery](interfaces/LogFileQuery)
* [DeleteLogRequest](interfaces/DeleteLogRequest)
* [ListScriptsQuery](interfaces/ListScriptsQuery)
* [ScriptDetailQuery](interfaces/ScriptDetailQuery)
* [CreateScriptRequest](interfaces/CreateScriptRequest)
* [UpdateScriptRequest](interfaces/UpdateScriptRequest)
* [DeleteScriptRequest](interfaces/DeleteScriptRequest)
* [RunScriptRequest](interfaces/RunScriptRequest)
* [StopScriptRequest](interfaces/StopScriptRequest)
* [RenameScriptRequest](interfaces/RenameScriptRequest)
* [IntervalSchedule](interfaces/IntervalSchedule)
* [SshPullOption](interfaces/SshPullOption)
* [UserPwdPullOption](interfaces/UserPwdPullOption)
* [Subscription](interfaces/Subscription)
* [CreateSubscriptionRequest](interfaces/CreateSubscriptionRequest)
* [UpdateSubscriptionRequest](interfaces/UpdateSubscriptionRequest)
* [ListSubscriptionsQuery](interfaces/ListSubscriptionsQuery)
* [DeleteSubscriptionsQuery](interfaces/DeleteSubscriptionsQuery)
* [UpdateSubscriptionStatusRequest](interfaces/UpdateSubscriptionStatusRequest)
* [SystemInfo](interfaces/SystemInfo)
* [SystemConfig](interfaces/SystemConfig)
* [NotifyRequest](interfaces/NotifyRequest)
* [CommandRunRequest](interfaces/CommandRunRequest)
* [CommandStopRequest](interfaces/CommandStopRequest)
* [ReloadRequest](interfaces/ReloadRequest)
* [ExportDataRequest](interfaces/ExportDataRequest)
* [ResetAuthRequest](interfaces/ResetAuthRequest)
* [SystemLogQuery](interfaces/SystemLogQuery)
* [UpdateLogRemoveFrequencyRequest](interfaces/UpdateLogRemoveFrequencyRequest)
* [UpdateCronConcurrencyRequest](interfaces/UpdateCronConcurrencyRequest)
* [UpdateDependenceProxyRequest](interfaces/UpdateDependenceProxyRequest)
* [UpdateNodeMirrorRequest](interfaces/UpdateNodeMirrorRequest)
* [UpdatePythonMirrorRequest](interfaces/UpdatePythonMirrorRequest)
* [UpdateLinuxMirrorRequest](interfaces/UpdateLinuxMirrorRequest)
* [UpdateTimezoneRequest](interfaces/UpdateTimezoneRequest)
* [UpdateLanguageRequest](interfaces/UpdateLanguageRequest)
* [UpdateGlobalSshKeyRequest](interfaces/UpdateGlobalSshKeyRequest)
* [CleanDependenceRequest](interfaces/CleanDependenceRequest)

## Type Aliases [#type-aliases]

* [AppScope](type-aliases/AppScope)
* [HttpMethod](type-aliases/HttpMethod)
* [SubscriptionType](type-aliases/SubscriptionType)
* [ScheduleType](type-aliases/ScheduleType)
* [PullType](type-aliases/PullType)


# QinglongApiError (/docs/reference/classes/QinglongApiError)



# Class: QinglongApiError [#class-qinglongapierror]

Defined in: [types/common.ts:31](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/common.ts#L31)

API 业务错误

## Extends [#extends]

* `Error`

## Constructors [#constructors]

### Constructor [#constructor]

> **new QinglongApiError**(`response`): `QinglongApiError`

Defined in: [types/common.ts:35](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/common.ts#L35)

#### Parameters [#parameters]

##### response [#response]

[`QinglongResponse`](../interfaces/QinglongResponse)

#### Returns [#returns]

`QinglongApiError`

#### Overrides [#overrides]

`Error.constructor`

## Properties [#properties]

### code [#code]

> `readonly` **code**: `number`

Defined in: [types/common.ts:32](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/common.ts#L32)

***

### errors? [#errors]

> `readonly` `optional` &#x2A;*errors?**: `object`\[]

Defined in: [types/common.ts:33](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/common.ts#L33)

#### message [#message]

> **message**: `string`

#### value? [#value]

> `optional` &#x2A;*value?**: `unknown`


# QinglongClient (/docs/reference/classes/QinglongClient)



# Class: QinglongClient [#class-qinglongclient]

Defined in: [client.ts:32](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/client.ts#L32)

青龙 Open API 客户端。

通过应用 client\_id / client\_secret 自动获取并管理 Bearer Token，
按 scope 调用 /open/\* 接口。

## Example [#example]

```typescript
const client = new QinglongClient({
  baseUrl: 'http://localhost:5700',
  clientId: 'your_client_id',
  clientSecret: 'your_client_secret',
});

await client.envs.list();
await client.crons.run([1]);
await client.system.notify({ title: 'Hi', content: 'Hello' });
```

## Constructors [#constructors]

### Constructor [#constructor]

> **new QinglongClient**(`options`): `QinglongClient`

Defined in: [client.ts:53](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/client.ts#L53)

#### Parameters [#parameters]

##### options [#options]

[`QinglongClientOptions`](../interfaces/QinglongClientOptions)

#### Returns [#returns]

`QinglongClient`

## Properties [#properties]

### envs [#envs]

> `readonly` **envs**: `EnvsApi`

Defined in: [client.ts:37](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/client.ts#L37)

环境变量 API（需要 envs scope）

***

### crons [#crons]

> `readonly` **crons**: `CronsApi`

Defined in: [client.ts:39](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/client.ts#L39)

定时任务 API（需要 crons scope）

***

### subscriptions [#subscriptions]

> `readonly` **subscriptions**: `SubscriptionsApi`

Defined in: [client.ts:41](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/client.ts#L41)

订阅管理 API（需要 subscriptions scope）

***

### configs [#configs]

> `readonly` **configs**: `ConfigsApi`

Defined in: [client.ts:43](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/client.ts#L43)

配置文件 API（需要 configs scope）

***

### scripts [#scripts]

> `readonly` **scripts**: `ScriptsApi`

Defined in: [client.ts:45](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/client.ts#L45)

脚本管理 API（需要 scripts scope）

***

### logs [#logs]

> `readonly` **logs**: `LogsApi`

Defined in: [client.ts:47](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/client.ts#L47)

日志管理 API（需要 logs scope）

***

### dependencies [#dependencies]

> `readonly` **dependencies**: `DependenciesApi`

Defined in: [client.ts:49](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/client.ts#L49)

依赖管理 API（需要 dependencies scope）

***

### system [#system]

> `readonly` **system**: `SystemApi`

Defined in: [client.ts:51](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/client.ts#L51)

系统管理 API（需要 system scope）


# CrontabStatus (/docs/reference/enumerations/CrontabStatus)



# Enumeration: CrontabStatus [#enumeration-crontabstatus]

Defined in: [types/cron.ts:2](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L2)

定时任务状态（对应 back/data/cron.ts CrontabStatus）

## Enumeration Members [#enumeration-members]

### Running [#running]

> **Running**: `0`

Defined in: [types/cron.ts:4](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L4)

运行中

***

### Idle [#idle]

> **Idle**: `1`

Defined in: [types/cron.ts:6](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L6)

空闲

***

### Disabled [#disabled]

> **Disabled**: `2`

Defined in: [types/cron.ts:8](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L8)

已禁用

***

### Queued [#queued]

> **Queued**: `3`

Defined in: [types/cron.ts:10](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L10)

排队中


# DependenceStatus (/docs/reference/enumerations/DependenceStatus)



# Enumeration: DependenceStatus [#enumeration-dependencestatus]

Defined in: [types/dependence.ts:2](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/dependence.ts#L2)

依赖状态

## Enumeration Members [#enumeration-members]

### Installing [#installing]

> **Installing**: `0`

Defined in: [types/dependence.ts:3](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/dependence.ts#L3)

***

### Installed [#installed]

> **Installed**: `1`

Defined in: [types/dependence.ts:4](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/dependence.ts#L4)

***

### InstallFailed [#installfailed]

> **InstallFailed**: `2`

Defined in: [types/dependence.ts:5](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/dependence.ts#L5)

***

### Removing [#removing]

> **Removing**: `3`

Defined in: [types/dependence.ts:6](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/dependence.ts#L6)

***

### Removed [#removed]

> **Removed**: `4`

Defined in: [types/dependence.ts:7](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/dependence.ts#L7)

***

### RemoveFailed [#removefailed]

> **RemoveFailed**: `5`

Defined in: [types/dependence.ts:8](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/dependence.ts#L8)

***

### Queued [#queued]

> **Queued**: `6`

Defined in: [types/dependence.ts:9](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/dependence.ts#L9)

***

### Cancelled [#cancelled]

> **Cancelled**: `7`

Defined in: [types/dependence.ts:10](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/dependence.ts#L10)


# DependenceType (/docs/reference/enumerations/DependenceType)



# Enumeration: DependenceType [#enumeration-dependencetype]

Defined in: [types/dependence.ts:14](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/dependence.ts#L14)

依赖类型

## Enumeration Members [#enumeration-members]

### Nodejs [#nodejs]

> **Nodejs**: `0`

Defined in: [types/dependence.ts:15](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/dependence.ts#L15)

***

### Python3 [#python3]

> **Python3**: `1`

Defined in: [types/dependence.ts:16](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/dependence.ts#L16)

***

### Linux [#linux]

> **Linux**: `2`

Defined in: [types/dependence.ts:17](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/dependence.ts#L17)


# EnvStatus (/docs/reference/enumerations/EnvStatus)



# Enumeration: EnvStatus [#enumeration-envstatus]

Defined in: [types/env.ts:2](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/env.ts#L2)

环境变量状态

## Enumeration Members [#enumeration-members]

### Normal [#normal]

> **Normal**: `0`

Defined in: [types/env.ts:4](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/env.ts#L4)

正常

***

### Disabled [#disabled]

> **Disabled**: `1`

Defined in: [types/env.ts:6](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/env.ts#L6)

已禁用


# InstanceStatus (/docs/reference/enumerations/InstanceStatus)



# Enumeration: InstanceStatus [#enumeration-instancestatus]

Defined in: [types/cron.ts:14](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L14)

运行实例状态

## Enumeration Members [#enumeration-members]

### Running [#running]

> **Running**: `0`

Defined in: [types/cron.ts:16](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L16)

运行中

***

### Finished [#finished]

> **Finished**: `1`

Defined in: [types/cron.ts:18](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L18)

已完成

***

### Stopped [#stopped]

> **Stopped**: `2`

Defined in: [types/cron.ts:20](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L20)

已停止

***

### Error [#error]

> **Error**: `3`

Defined in: [types/cron.ts:22](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L22)

出错


# SubscriptionStatus (/docs/reference/enumerations/SubscriptionStatus)



# Enumeration: SubscriptionStatus [#enumeration-subscriptionstatus]

Defined in: [types/subscription.ts:2](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L2)

订阅状态

## Enumeration Members [#enumeration-members]

### Running [#running]

> **Running**: `0`

Defined in: [types/subscription.ts:4](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L4)

运行中

***

### Idle [#idle]

> **Idle**: `1`

Defined in: [types/subscription.ts:6](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L6)

空闲

***

### Disabled [#disabled]

> **Disabled**: `2`

Defined in: [types/subscription.ts:8](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L8)

已禁用

***

### Queued [#queued]

> **Queued**: `3`

Defined in: [types/subscription.ts:10](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L10)

排队中


# AppScope (/docs/reference/type-aliases/AppScope)



# Type Alias: AppScope [#type-alias-appscope]

> **AppScope** = `"crons"` | `"envs"` | `"subscriptions"` | `"configs"` | `"scripts"` | `"logs"` | `"dependencies"` | `"system"` | `"dashboard"`

Defined in: [types/common.ts:7](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/common.ts#L7)

Open API 应用权限范围


# HttpMethod (/docs/reference/type-aliases/HttpMethod)



# Type Alias: HttpMethod [#type-alias-httpmethod]

> **HttpMethod** = `"GET"` | `"POST"` | `"PUT"` | `"DELETE"`

Defined in: [types/common.ts:58](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/common.ts#L58)

HTTP 请求方法


# PullType (/docs/reference/type-aliases/PullType)



# Type Alias: PullType [#type-alias-pulltype]

> **PullType** = `"ssh-key"` | `"user-pwd"`

Defined in: [types/subscription.ts:20](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L20)

拉取方式


# ScheduleType (/docs/reference/type-aliases/ScheduleType)



# Type Alias: ScheduleType [#type-alias-scheduletype]

> **ScheduleType** = `"crontab"` | `"interval"`

Defined in: [types/subscription.ts:17](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L17)

定时类型


# SubscriptionType (/docs/reference/type-aliases/SubscriptionType)



# Type Alias: SubscriptionType [#type-alias-subscriptiontype]

> **SubscriptionType** = `"public-repo"` | `"private-repo"` | `"file"`

Defined in: [types/subscription.ts:14](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L14)

订阅类型


# AuthToken (/docs/reference/interfaces/AuthToken)



# Interface: AuthToken [#interface-authtoken]

Defined in: [types/auth.ts:2](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/auth.ts#L2)

认证 Token 数据

## Properties [#properties]

### token [#token]

> **token**: `string`

Defined in: [types/auth.ts:4](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/auth.ts#L4)

Bearer Token 值

***

### token\_type [#token_type]

> **token\_type**: `"Bearer"`

Defined in: [types/auth.ts:6](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/auth.ts#L6)

Token 类型，固定为 Bearer

***

### expiration [#expiration]

> **expiration**: `number`

Defined in: [types/auth.ts:8](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/auth.ts#L8)

过期时间（Unix 秒级时间戳），默认 30 天


# AuthTokenQuery (/docs/reference/interfaces/AuthTokenQuery)



# Interface: AuthTokenQuery [#interface-authtokenquery]

Defined in: [types/auth.ts:12](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/auth.ts#L12)

GET /open/auth/token 查询参数

## Properties [#properties]

### client\_id [#client_id]

> **client\_id**: `string`

Defined in: [types/auth.ts:13](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/auth.ts#L13)

***

### client\_secret [#client_secret]

> **client\_secret**: `string`

Defined in: [types/auth.ts:14](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/auth.ts#L14)


# CleanDependenceRequest (/docs/reference/interfaces/CleanDependenceRequest)



# Interface: CleanDependenceRequest [#interface-cleandependencerequest]

Defined in: [types/system.ts:102](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/system.ts#L102)

## Properties [#properties]

### type? [#type]

> `optional` &#x2A;*type?**: `string`

Defined in: [types/system.ts:103](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/system.ts#L103)


# CommandRunRequest (/docs/reference/interfaces/CommandRunRequest)



# Interface: CommandRunRequest [#interface-commandrunrequest]

Defined in: [types/system.ts:31](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/system.ts#L31)

PUT /open/system/command-run 运行命令

## Properties [#properties]

### command [#command]

> **command**: `string`

Defined in: [types/system.ts:32](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/system.ts#L32)


# CommandStopRequest (/docs/reference/interfaces/CommandStopRequest)



# Interface: CommandStopRequest [#interface-commandstoprequest]

Defined in: [types/system.ts:36](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/system.ts#L36)

PUT /open/system/command-stop 停止命令

## Properties [#properties]

### command? [#command]

> `optional` &#x2A;*command?**: `string`

Defined in: [types/system.ts:37](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/system.ts#L37)

***

### pid? [#pid]

> `optional` &#x2A;*pid?**: `number`

Defined in: [types/system.ts:38](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/system.ts#L38)


# ConfigDetailQuery (/docs/reference/interfaces/ConfigDetailQuery)



# Interface: ConfigDetailQuery [#interface-configdetailquery]

Defined in: [types/config.ts:8](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/config.ts#L8)

GET /open/configs/detail 查询参数

## Properties [#properties]

### path [#path]

> **path**: `string`

Defined in: [types/config.ts:9](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/config.ts#L9)


# ConfigFileItem (/docs/reference/interfaces/ConfigFileItem)



# Interface: ConfigFileItem [#interface-configfileitem]

Defined in: [types/config.ts:2](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/config.ts#L2)

配置文件列表项

## Properties [#properties]

### title [#title]

> **title**: `string`

Defined in: [types/config.ts:3](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/config.ts#L3)

***

### value [#value]

> **value**: `string`

Defined in: [types/config.ts:4](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/config.ts#L4)


# CreateCronViewRequest (/docs/reference/interfaces/CreateCronViewRequest)



# Interface: CreateCronViewRequest [#interface-createcronviewrequest]

Defined in: [types/cron.ts:168](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L168)

POST /open/crons/views 创建视图

## Extended by [#extended-by]

* [`UpdateCronViewRequest`](UpdateCronViewRequest)

## Properties [#properties]

### name [#name]

> **name**: `string`

Defined in: [types/cron.ts:169](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L169)

***

### sorts? [#sorts]

> `optional` &#x2A;*sorts?**: [`CronViewSort`](CronViewSort)\[] | `null`

Defined in: [types/cron.ts:170](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L170)

***

### filters? [#filters]

> `optional` &#x2A;*filters?**: [`CronViewFilter`](CronViewFilter)\[]

Defined in: [types/cron.ts:171](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L171)

***

### filterRelation? [#filterrelation]

> `optional` &#x2A;*filterRelation?**: `string`

Defined in: [types/cron.ts:172](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L172)


# CreateDependenceItem (/docs/reference/interfaces/CreateDependenceItem)



# Interface: CreateDependenceItem [#interface-createdependenceitem]

Defined in: [types/dependence.ts:39](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/dependence.ts#L39)

POST /open/dependencies 单项

## Properties [#properties]

### name [#name]

> **name**: `string`

Defined in: [types/dependence.ts:40](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/dependence.ts#L40)

***

### type [#type]

> **type**: [`DependenceType`](../enumerations/DependenceType)

Defined in: [types/dependence.ts:41](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/dependence.ts#L41)

***

### remark? [#remark]

> `optional` &#x2A;*remark?**: `string`

Defined in: [types/dependence.ts:42](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/dependence.ts#L42)


# CreateEnvItem (/docs/reference/interfaces/CreateEnvItem)



# Interface: CreateEnvItem [#interface-createenvitem]

Defined in: [types/env.ts:35](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/env.ts#L35)

POST /open/envs 单项（批量创建）

## Properties [#properties]

### name [#name]

> **name**: `string`

Defined in: [types/env.ts:40](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/env.ts#L40)

变量名

#### Remarks [#remarks]

正则：/^\[a-zA-Z\_]\[0-9a-zA-Z\_]\*$/

***

### value [#value]

> **value**: `string`

Defined in: [types/env.ts:42](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/env.ts#L42)

变量值

***

### remarks? [#remarks-1]

> `optional` &#x2A;*remarks?**: `string`

Defined in: [types/env.ts:44](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/env.ts#L44)

备注

***

### labels? [#labels]

> `optional` &#x2A;*labels?**: `string`\[]

Defined in: [types/env.ts:46](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/env.ts#L46)

标签


# CreateScriptRequest (/docs/reference/interfaces/CreateScriptRequest)



# Interface: CreateScriptRequest [#interface-createscriptrequest]

Defined in: [types/script.ts:15](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/script.ts#L15)

POST /open/scripts 创建/上传请求

## Properties [#properties]

### filename [#filename]

> **filename**: `string`

Defined in: [types/script.ts:16](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/script.ts#L16)

***

### path? [#path]

> `optional` &#x2A;*path?**: `string`

Defined in: [types/script.ts:17](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/script.ts#L17)

***

### content? [#content]

> `optional` &#x2A;*content?**: `string`

Defined in: [types/script.ts:18](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/script.ts#L18)

***

### originFilename? [#originfilename]

> `optional` &#x2A;*originFilename?**: `string`

Defined in: [types/script.ts:19](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/script.ts#L19)

***

### directory? [#directory]

> `optional` &#x2A;*directory?**: `string`

Defined in: [types/script.ts:21](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/script.ts#L21)

创建目录时使用


# CreateSubscriptionRequest (/docs/reference/interfaces/CreateSubscriptionRequest)



# Interface: CreateSubscriptionRequest [#interface-createsubscriptionrequest]

Defined in: [types/subscription.ts:71](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L71)

POST /open/subscriptions 创建请求

## Extended by [#extended-by]

* [`UpdateSubscriptionRequest`](UpdateSubscriptionRequest)

## Properties [#properties]

### type [#type]

> **type**: `string`

Defined in: [types/subscription.ts:72](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L72)

***

### url [#url]

> **url**: `string`

Defined in: [types/subscription.ts:73](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L73)

***

### alias [#alias]

> **alias**: `string`

Defined in: [types/subscription.ts:74](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L74)

***

### schedule\_type [#schedule_type]

> **schedule\_type**: `string`

Defined in: [types/subscription.ts:75](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L75)

***

### schedule? [#schedule]

> `optional` &#x2A;*schedule?**: `string` | `null`

Defined in: [types/subscription.ts:76](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L76)

***

### interval\_schedule? [#interval_schedule]

> `optional` &#x2A;*interval\_schedule?**: [`IntervalSchedule`](IntervalSchedule) | `null`

Defined in: [types/subscription.ts:77](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L77)

***

### name? [#name]

> `optional` &#x2A;*name?**: `string` | `null`

Defined in: [types/subscription.ts:78](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L78)

***

### whitelist? [#whitelist]

> `optional` &#x2A;*whitelist?**: `string` | `null`

Defined in: [types/subscription.ts:79](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L79)

***

### blacklist? [#blacklist]

> `optional` &#x2A;*blacklist?**: `string` | `null`

Defined in: [types/subscription.ts:80](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L80)

***

### branch? [#branch]

> `optional` &#x2A;*branch?**: `string` | `null`

Defined in: [types/subscription.ts:81](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L81)

***

### dependences? [#dependences]

> `optional` &#x2A;*dependences?**: `string` | `null`

Defined in: [types/subscription.ts:82](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L82)

***

### pull\_type? [#pull_type]

> `optional` &#x2A;*pull\_type?**: `string` | `null`

Defined in: [types/subscription.ts:83](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L83)

***

### pull\_option? [#pull_option]

> `optional` &#x2A;*pull\_option?**: `Record`\<`string`, `unknown`> | `null`

Defined in: [types/subscription.ts:84](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L84)

***

### extensions? [#extensions]

> `optional` &#x2A;*extensions?**: `string` | `null`

Defined in: [types/subscription.ts:85](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L85)

***

### sub\_before? [#sub_before]

> `optional` &#x2A;*sub\_before?**: `string` | `null`

Defined in: [types/subscription.ts:86](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L86)

***

### sub\_after? [#sub_after]

> `optional` &#x2A;*sub\_after?**: `string` | `null`

Defined in: [types/subscription.ts:87](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L87)

***

### proxy? [#proxy]

> `optional` &#x2A;*proxy?**: `string` | `null`

Defined in: [types/subscription.ts:88](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L88)

***

### autoAddCron? [#autoaddcron]

> `optional` &#x2A;*autoAddCron?**: `boolean` | `null`

Defined in: [types/subscription.ts:89](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L89)

***

### autoDelCron? [#autodelcron]

> `optional` &#x2A;*autoDelCron?**: `boolean` | `null`

Defined in: [types/subscription.ts:90](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L90)


# CronDetailQuery (/docs/reference/interfaces/CronDetailQuery)



# Interface: CronDetailQuery [#interface-crondetailquery]

Defined in: [types/cron.ts:108](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L108)

GET /open/crons/detail 查询参数（对应 back/services/cron.ts find，仅支持 log\_path）

## Properties [#properties]

### log\_path [#log_path]

> **log\_path**: `string`

Defined in: [types/cron.ts:109](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L109)


# CronLabelsRequest (/docs/reference/interfaces/CronLabelsRequest)



# Interface: CronLabelsRequest [#interface-cronlabelsrequest]

Defined in: [types/cron.ts:124](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L124)

POST/DELETE /open/crons/labels 标签操作

## Properties [#properties]

### ids [#ids]

> **ids**: `number`\[]

Defined in: [types/cron.ts:125](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L125)

***

### labels [#labels]

> **labels**: `string`\[]

Defined in: [types/cron.ts:126](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L126)


# CronMutationRequest (/docs/reference/interfaces/CronMutationRequest)



# Interface: CronMutationRequest [#interface-cronmutationrequest]

Defined in: [types/cron.ts:31](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L31)

创建/更新定时任务请求体（来自 commonCronSchema）

## Extended by [#extended-by]

* [`UpdateCronRequest`](UpdateCronRequest)
* [`Crontab`](Crontab)

## Properties [#properties]

### name? [#name]

> `optional` &#x2A;*name?**: `string`

Defined in: [types/cron.ts:33](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L33)

任务名称

***

### command [#command]

> **command**: `string`

Defined in: [types/cron.ts:35](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L35)

执行的命令或脚本，必填

***

### schedule [#schedule]

> **schedule**: `string`

Defined in: [types/cron.ts:40](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L40)

标准 5 位 cron 表达式，或特殊值 once / boot（前缀 @）

#### Remarks [#remarks]

无效的定时规则会被服务端拒绝

***

### labels? [#labels]

> `optional` &#x2A;*labels?**: `string`\[]

Defined in: [types/cron.ts:42](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L42)

标签列表

***

### sub\_id? [#sub_id]

> `optional` &#x2A;*sub\_id?**: `number` | `null`

Defined in: [types/cron.ts:44](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L44)

关联订阅 ID，null 表示无

***

### extra\_schedules? [#extra_schedules]

> `optional` &#x2A;*extra\_schedules?**: [`ExtraSchedule`](ExtraSchedule)\[] | `null`

Defined in: [types/cron.ts:46](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L46)

额外定时规则

***

### task\_before? [#task_before]

> `optional` &#x2A;*task\_before?**: `string` | `null`

Defined in: [types/cron.ts:48](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L48)

任务执行前命令

***

### task\_after? [#task_after]

> `optional` &#x2A;*task\_after?**: `string` | `null`

Defined in: [types/cron.ts:50](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L50)

任务执行后命令

***

### log\_name? [#log_name]

> `optional` &#x2A;*log\_name?**: `string` | `null`

Defined in: [types/cron.ts:55](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L55)

自定义日志路径

#### Remarks [#remarks-1]

相对路径限字母数字下划线连字符；绝对路径须在日志目录内或使用 /dev/null

***

### allow\_multiple\_instances? [#allow_multiple_instances]

> `optional` &#x2A;*allow\_multiple\_instances?**: `0` | `1` | `null`

Defined in: [types/cron.ts:57](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L57)

是否允许多实例：0=否，1=是

***

### work\_dir? [#work_dir]

> `optional` &#x2A;*work\_dir?**: `string` | `null`

Defined in: [types/cron.ts:59](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L59)

工作目录


# CronView (/docs/reference/interfaces/CronView)



# Interface: CronView [#interface-cronview]

Defined in: [types/cron.ts:155](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L155)

定时任务视图

## Properties [#properties]

### id? [#id]

> `optional` &#x2A;*id?**: `number`

Defined in: [types/cron.ts:156](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L156)

***

### name? [#name]

> `optional` &#x2A;*name?**: `string`

Defined in: [types/cron.ts:157](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L157)

***

### position? [#position]

> `optional` &#x2A;*position?**: `number`

Defined in: [types/cron.ts:158](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L158)

***

### isDisabled? [#isdisabled]

> `optional` &#x2A;*isDisabled?**: `0` | `1`

Defined in: [types/cron.ts:159](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L159)

***

### filters? [#filters]

> `optional` &#x2A;*filters?**: [`CronViewFilter`](CronViewFilter)\[]

Defined in: [types/cron.ts:160](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L160)

***

### sorts? [#sorts]

> `optional` &#x2A;*sorts?**: [`CronViewSort`](CronViewSort)\[] | `null`

Defined in: [types/cron.ts:161](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L161)

***

### filterRelation? [#filterrelation]

> `optional` &#x2A;*filterRelation?**: `"and"` | `"or"`

Defined in: [types/cron.ts:162](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L162)

***

### type? [#type]

> `optional` &#x2A;*type?**: `1` | `2`

Defined in: [types/cron.ts:164](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L164)

1=系统视图，2=个人视图


# CronViewFilter (/docs/reference/interfaces/CronViewFilter)



# Interface: CronViewFilter [#interface-cronviewfilter]

Defined in: [types/cron.ts:148](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L148)

视图筛选

## Properties [#properties]

### property [#property]

> **property**: `string`

Defined in: [types/cron.ts:149](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L149)

***

### operation [#operation]

> **operation**: `string`

Defined in: [types/cron.ts:150](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L150)

***

### value [#value]

> **value**: `string`

Defined in: [types/cron.ts:151](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L151)


# CronViewSort (/docs/reference/interfaces/CronViewSort)



# Interface: CronViewSort [#interface-cronviewsort]

Defined in: [types/cron.ts:142](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L142)

视图排序

## Properties [#properties]

### type [#type]

> **type**: `"ASC"` | `"DESC"`

Defined in: [types/cron.ts:143](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L143)

***

### value [#value]

> **value**: `string`

Defined in: [types/cron.ts:144](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L144)


# Crontab (/docs/reference/interfaces/Crontab)



# Interface: Crontab [#interface-crontab]

Defined in: [types/cron.ts:68](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L68)

定时任务完整实体

## Extends [#extends]

* [`CronMutationRequest`](CronMutationRequest)

## Properties [#properties]

### name? [#name]

> `optional` &#x2A;*name?**: `string`

Defined in: [types/cron.ts:33](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L33)

任务名称

#### Inherited from [#inherited-from]

[`CronMutationRequest`](CronMutationRequest).[`name`](CronMutationRequest#name)

***

### command [#command]

> **command**: `string`

Defined in: [types/cron.ts:35](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L35)

执行的命令或脚本，必填

#### Inherited from [#inherited-from-1]

[`CronMutationRequest`](CronMutationRequest).[`command`](CronMutationRequest#command)

***

### schedule [#schedule]

> **schedule**: `string`

Defined in: [types/cron.ts:40](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L40)

标准 5 位 cron 表达式，或特殊值 once / boot（前缀 @）

#### Remarks [#remarks]

无效的定时规则会被服务端拒绝

#### Inherited from [#inherited-from-2]

[`CronMutationRequest`](CronMutationRequest).[`schedule`](CronMutationRequest#schedule)

***

### labels? [#labels]

> `optional` &#x2A;*labels?**: `string`\[]

Defined in: [types/cron.ts:42](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L42)

标签列表

#### Inherited from [#inherited-from-3]

[`CronMutationRequest`](CronMutationRequest).[`labels`](CronMutationRequest#labels)

***

### sub\_id? [#sub_id]

> `optional` &#x2A;*sub\_id?**: `number` | `null`

Defined in: [types/cron.ts:44](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L44)

关联订阅 ID，null 表示无

#### Inherited from [#inherited-from-4]

[`CronMutationRequest`](CronMutationRequest).[`sub_id`](CronMutationRequest#sub_id)

***

### extra\_schedules? [#extra_schedules]

> `optional` &#x2A;*extra\_schedules?**: [`ExtraSchedule`](ExtraSchedule)\[] | `null`

Defined in: [types/cron.ts:46](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L46)

额外定时规则

#### Inherited from [#inherited-from-5]

[`CronMutationRequest`](CronMutationRequest).[`extra_schedules`](CronMutationRequest#extra_schedules)

***

### task\_before? [#task_before]

> `optional` &#x2A;*task\_before?**: `string` | `null`

Defined in: [types/cron.ts:48](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L48)

任务执行前命令

#### Inherited from [#inherited-from-6]

[`CronMutationRequest`](CronMutationRequest).[`task_before`](CronMutationRequest#task_before)

***

### task\_after? [#task_after]

> `optional` &#x2A;*task\_after?**: `string` | `null`

Defined in: [types/cron.ts:50](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L50)

任务执行后命令

#### Inherited from [#inherited-from-7]

[`CronMutationRequest`](CronMutationRequest).[`task_after`](CronMutationRequest#task_after)

***

### log\_name? [#log_name]

> `optional` &#x2A;*log\_name?**: `string` | `null`

Defined in: [types/cron.ts:55](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L55)

自定义日志路径

#### Remarks [#remarks-1]

相对路径限字母数字下划线连字符；绝对路径须在日志目录内或使用 /dev/null

#### Inherited from [#inherited-from-8]

[`CronMutationRequest`](CronMutationRequest).[`log_name`](CronMutationRequest#log_name)

***

### allow\_multiple\_instances? [#allow_multiple_instances]

> `optional` &#x2A;*allow\_multiple\_instances?**: `0` | `1` | `null`

Defined in: [types/cron.ts:57](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L57)

是否允许多实例：0=否，1=是

#### Inherited from [#inherited-from-9]

[`CronMutationRequest`](CronMutationRequest).[`allow_multiple_instances`](CronMutationRequest#allow_multiple_instances)

***

### work\_dir? [#work_dir]

> `optional` &#x2A;*work\_dir?**: `string` | `null`

Defined in: [types/cron.ts:59](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L59)

工作目录

#### Inherited from [#inherited-from-10]

[`CronMutationRequest`](CronMutationRequest).[`work_dir`](CronMutationRequest#work_dir)

***

### id? [#id]

> `optional` &#x2A;*id?**: `number`

Defined in: [types/cron.ts:69](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L69)

***

### status? [#status]

> `optional` &#x2A;*status?**: [`CrontabStatus`](../enumerations/CrontabStatus)

Defined in: [types/cron.ts:70](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L70)

***

### isSystem? [#issystem]

> `optional` &#x2A;*isSystem?**: `0` | `1`

Defined in: [types/cron.ts:71](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L71)

***

### isDisabled? [#isdisabled]

> `optional` &#x2A;*isDisabled?**: `0` | `1`

Defined in: [types/cron.ts:72](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L72)

***

### isPinned? [#ispinned]

> `optional` &#x2A;*isPinned?**: `0` | `1`

Defined in: [types/cron.ts:73](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L73)

***

### pid? [#pid]

> `optional` &#x2A;*pid?**: `number`

Defined in: [types/cron.ts:74](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L74)

***

### log\_path? [#log_path]

> `optional` &#x2A;*log\_path?**: `string`

Defined in: [types/cron.ts:75](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L75)

***

### last\_running\_time? [#last_running_time]

> `optional` &#x2A;*last\_running\_time?**: `number`

Defined in: [types/cron.ts:76](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L76)

***

### last\_execution\_time? [#last_execution_time]

> `optional` &#x2A;*last\_execution\_time?**: `number`

Defined in: [types/cron.ts:77](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L77)

***

### timestamp? [#timestamp]

> `optional` &#x2A;*timestamp?**: `string`

Defined in: [types/cron.ts:78](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L78)

***

### saved? [#saved]

> `optional` &#x2A;*saved?**: `boolean`

Defined in: [types/cron.ts:79](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L79)


# DeleteLogRequest (/docs/reference/interfaces/DeleteLogRequest)



# Interface: DeleteLogRequest [#interface-deletelogrequest]

Defined in: [types/log.ts:15](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/log.ts#L15)

DELETE /open/logs 删除请求

## Extends [#extends]

* [`FilePathRequest`](FilePathRequest)

## Properties [#properties]

### path? [#path]

> `optional` &#x2A;*path?**: `string`

Defined in: [types/file.ts:15](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/file.ts#L15)

文件相对路径

#### Inherited from [#inherited-from]

[`FilePathRequest`](FilePathRequest).[`path`](FilePathRequest#path)

***

### filename [#filename]

> **filename**: `string`

Defined in: [types/file.ts:17](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/file.ts#L17)

文件名

#### Inherited from [#inherited-from-1]

[`FilePathRequest`](FilePathRequest).[`filename`](FilePathRequest#filename)

***

### type? [#type]

> `optional` &#x2A;*type?**: `string`

Defined in: [types/log.ts:16](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/log.ts#L16)


# DeleteScriptRequest (/docs/reference/interfaces/DeleteScriptRequest)



# Interface: DeleteScriptRequest [#interface-deletescriptrequest]

Defined in: [types/script.ts:32](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/script.ts#L32)

DELETE /open/scripts 删除请求

## Extends [#extends]

* [`FilePathRequest`](FilePathRequest)

## Properties [#properties]

### path? [#path]

> `optional` &#x2A;*path?**: `string`

Defined in: [types/file.ts:15](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/file.ts#L15)

文件相对路径

#### Inherited from [#inherited-from]

[`FilePathRequest`](FilePathRequest).[`path`](FilePathRequest#path)

***

### filename [#filename]

> **filename**: `string`

Defined in: [types/file.ts:17](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/file.ts#L17)

文件名

#### Inherited from [#inherited-from-1]

[`FilePathRequest`](FilePathRequest).[`filename`](FilePathRequest#filename)

***

### type? [#type]

> `optional` &#x2A;*type?**: `string`

Defined in: [types/script.ts:33](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/script.ts#L33)


# DeleteSubscriptionsQuery (/docs/reference/interfaces/DeleteSubscriptionsQuery)



# Interface: DeleteSubscriptionsQuery [#interface-deletesubscriptionsquery]

Defined in: [types/subscription.ts:106](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L106)

DELETE /open/subscriptions 查询参数

## Properties [#properties]

### force? [#force]

> `optional` &#x2A;*force?**: `boolean`

Defined in: [types/subscription.ts:107](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L107)


# Dependence (/docs/reference/interfaces/Dependence)



# Interface: Dependence [#interface-dependence]

Defined in: [types/dependence.ts:21](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/dependence.ts#L21)

依赖实体（对应 back/data/dependence.ts）

## Properties [#properties]

### id? [#id]

> `optional` &#x2A;*id?**: `number`

Defined in: [types/dependence.ts:22](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/dependence.ts#L22)

***

### name [#name]

> **name**: `string`

Defined in: [types/dependence.ts:23](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/dependence.ts#L23)

***

### type [#type]

> **type**: [`DependenceType`](../enumerations/DependenceType)

Defined in: [types/dependence.ts:24](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/dependence.ts#L24)

***

### status [#status]

> **status**: [`DependenceStatus`](../enumerations/DependenceStatus)

Defined in: [types/dependence.ts:25](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/dependence.ts#L25)

***

### timestamp? [#timestamp]

> `optional` &#x2A;*timestamp?**: `string`

Defined in: [types/dependence.ts:26](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/dependence.ts#L26)

***

### log? [#log]

> `optional` &#x2A;*log?**: `string`\[]

Defined in: [types/dependence.ts:27](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/dependence.ts#L27)

***

### remark? [#remark]

> `optional` &#x2A;*remark?**: `string`

Defined in: [types/dependence.ts:28](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/dependence.ts#L28)


# Env (/docs/reference/interfaces/Env)



# Interface: Env [#interface-env]

Defined in: [types/env.ts:10](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/env.ts#L10)

环境变量实体（对应 back/data/env.ts）

## Properties [#properties]

### id? [#id]

> `optional` &#x2A;*id?**: `number`

Defined in: [types/env.ts:12](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/env.ts#L12)

环境变量 ID

***

### name? [#name]

> `optional` &#x2A;*name?**: `string`

Defined in: [types/env.ts:17](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/env.ts#L17)

变量名

#### Remarks [#remarks]

必须以字母或下划线开头，仅含字母/数字/下划线

***

### value? [#value]

> `optional` &#x2A;*value?**: `string`

Defined in: [types/env.ts:19](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/env.ts#L19)

变量值

***

### remarks? [#remarks-1]

> `optional` &#x2A;*remarks?**: `string`

Defined in: [types/env.ts:21](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/env.ts#L21)

备注

***

### status? [#status]

> `optional` &#x2A;*status?**: [`EnvStatus`](../enumerations/EnvStatus)

Defined in: [types/env.ts:23](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/env.ts#L23)

状态

***

### position? [#position]

> `optional` &#x2A;*position?**: `number`

Defined in: [types/env.ts:25](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/env.ts#L25)

排序位置

***

### isPinned? [#ispinned]

> `optional` &#x2A;*isPinned?**: `0` | `1`

Defined in: [types/env.ts:27](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/env.ts#L27)

是否置顶：0=否，1=是

***

### labels? [#labels]

> `optional` &#x2A;*labels?**: `string`\[]

Defined in: [types/env.ts:29](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/env.ts#L29)

标签列表

***

### timestamp? [#timestamp]

> `optional` &#x2A;*timestamp?**: `string`

Defined in: [types/env.ts:31](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/env.ts#L31)

时间戳


# EnvLabelsRequest (/docs/reference/interfaces/EnvLabelsRequest)



# Interface: EnvLabelsRequest [#interface-envlabelsrequest]

Defined in: [types/env.ts:77](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/env.ts#L77)

POST/DELETE /open/envs/labels 标签操作

## Properties [#properties]

### ids [#ids]

> **ids**: `number`\[]

Defined in: [types/env.ts:78](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/env.ts#L78)

***

### labels [#labels]

> **labels**: `string`\[]

Defined in: [types/env.ts:79](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/env.ts#L79)


# ExportDataRequest (/docs/reference/interfaces/ExportDataRequest)



# Interface: ExportDataRequest [#interface-exportdatarequest]

Defined in: [types/system.ts:47](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/system.ts#L47)

PUT /open/system/data/export 导出数据

## Properties [#properties]

### type? [#type]

> `optional` &#x2A;*type?**: `string`\[]

Defined in: [types/system.ts:48](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/system.ts#L48)


# ExtraSchedule (/docs/reference/interfaces/ExtraSchedule)



# Interface: ExtraSchedule [#interface-extraschedule]

Defined in: [types/cron.ts:26](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L26)

额外定时规则

## Properties [#properties]

### schedule [#schedule]

> **schedule**: `string`

Defined in: [types/cron.ts:27](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L27)


# FileNode (/docs/reference/interfaces/FileNode)



# Interface: FileNode [#interface-filenode]

Defined in: [types/file.ts:2](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/file.ts#L2)

文件/目录树节点（对应 back/config/util.ts IFile）

## Properties [#properties]

### title [#title]

> **title**: `string`

Defined in: [types/file.ts:3](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/file.ts#L3)

***

### key [#key]

> **key**: `string`

Defined in: [types/file.ts:4](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/file.ts#L4)

***

### type [#type]

> **type**: `"directory"` | `"file"`

Defined in: [types/file.ts:5](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/file.ts#L5)

***

### parent [#parent]

> **parent**: `string`

Defined in: [types/file.ts:6](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/file.ts#L6)

***

### createTime [#createtime]

> **createTime**: `number`

Defined in: [types/file.ts:7](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/file.ts#L7)

***

### size? [#size]

> `optional` &#x2A;*size?**: `number`

Defined in: [types/file.ts:8](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/file.ts#L8)

***

### children? [#children]

> `optional` &#x2A;*children?**: `FileNode`\[]

Defined in: [types/file.ts:9](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/file.ts#L9)


# FilePathRequest (/docs/reference/interfaces/FilePathRequest)



# Interface: FilePathRequest [#interface-filepathrequest]

Defined in: [types/file.ts:13](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/file.ts#L13)

脚本/日志文件操作通用请求

## Extended by [#extended-by]

* [`DeleteScriptRequest`](DeleteScriptRequest)
* [`DeleteLogRequest`](DeleteLogRequest)

## Properties [#properties]

### path? [#path]

> `optional` &#x2A;*path?**: `string`

Defined in: [types/file.ts:15](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/file.ts#L15)

文件相对路径

***

### filename [#filename]

> **filename**: `string`

Defined in: [types/file.ts:17](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/file.ts#L17)

文件名


# IntervalSchedule (/docs/reference/interfaces/IntervalSchedule)



# Interface: IntervalSchedule [#interface-intervalschedule]

Defined in: [types/subscription.ts:23](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L23)

间隔定时配置

## Properties [#properties]

### type [#type]

> **type**: `string`

Defined in: [types/subscription.ts:24](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L24)

***

### value [#value]

> **value**: `number`

Defined in: [types/subscription.ts:25](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L25)


# ListCronsQuery (/docs/reference/interfaces/ListCronsQuery)



# Interface: ListCronsQuery [#interface-listcronsquery]

Defined in: [types/cron.ts:89](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L89)

GET /open/crons 查询参数（对应 back/services/cron.ts crontabs）

## Properties [#properties]

### searchValue? [#searchvalue]

> `optional` &#x2A;*searchValue?**: `string`

Defined in: [types/cron.ts:94](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L94)

搜索关键词。纯文本模糊匹配 name/command/schedule/labels；
或使用前缀：`name:xxx`、`command:xxx`、`schedule:xxx`、`label:xxx`

***

### page? [#page]

> `optional` &#x2A;*page?**: `string`

Defined in: [types/cron.ts:96](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L96)

页码（从 1 开始，需配合 size）

***

### size? [#size]

> `optional` &#x2A;*size?**: `string`

Defined in: [types/cron.ts:98](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L98)

每页条数

***

### sorter? [#sorter]

> `optional` &#x2A;*sorter?**: `string`

Defined in: [types/cron.ts:100](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L100)

排序，JSON 字符串，如 `{"field":"name","type":"ASC"}`

***

### filters? [#filters]

> `optional` &#x2A;*filters?**: `string`

Defined in: [types/cron.ts:102](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L102)

筛选条件，JSON 字符串

***

### queryString? [#querystring]

> `optional` &#x2A;*queryString?**: `string`

Defined in: [types/cron.ts:104](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L104)

视图筛选/排序，JSON 字符串（含 filters、sorts、filterRelation）


# ListCronsResult (/docs/reference/interfaces/ListCronsResult)



# Interface: ListCronsResult [#interface-listcronsresult]

Defined in: [types/cron.ts:83](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L83)

GET /open/crons 响应（对应 back/services/cron.ts crontabs）

## Properties [#properties]

### data [#data]

> **data**: [`Crontab`](Crontab)\[]

Defined in: [types/cron.ts:84](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L84)

***

### total [#total]

> **total**: `number`

Defined in: [types/cron.ts:85](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L85)


# ListDependenciesQuery (/docs/reference/interfaces/ListDependenciesQuery)



# Interface: ListDependenciesQuery [#interface-listdependenciesquery]

Defined in: [types/dependence.ts:32](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/dependence.ts#L32)

GET /open/dependencies 查询参数

## Properties [#properties]

### searchValue? [#searchvalue]

> `optional` &#x2A;*searchValue?**: `string`

Defined in: [types/dependence.ts:33](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/dependence.ts#L33)

***

### type? [#type]

> `optional` &#x2A;*type?**: `string`

Defined in: [types/dependence.ts:34](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/dependence.ts#L34)

***

### status? [#status]

> `optional` &#x2A;*status?**: `string`

Defined in: [types/dependence.ts:35](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/dependence.ts#L35)


# ListEnvsQuery (/docs/reference/interfaces/ListEnvsQuery)



# Interface: ListEnvsQuery [#interface-listenvsquery]

Defined in: [types/env.ts:59](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/env.ts#L59)

GET /open/envs 查询参数

## Properties [#properties]

### searchValue? [#searchvalue]

> `optional` &#x2A;*searchValue?**: `string`

Defined in: [types/env.ts:61](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/env.ts#L61)

搜索关键词


# ListScriptsQuery (/docs/reference/interfaces/ListScriptsQuery)



# Interface: ListScriptsQuery [#interface-listscriptsquery]

Defined in: [types/script.ts:4](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/script.ts#L4)

GET /open/scripts 查询参数

## Properties [#properties]

### path? [#path]

> `optional` &#x2A;*path?**: `string`

Defined in: [types/script.ts:5](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/script.ts#L5)


# ListSubscriptionsQuery (/docs/reference/interfaces/ListSubscriptionsQuery)



# Interface: ListSubscriptionsQuery [#interface-listsubscriptionsquery]

Defined in: [types/subscription.ts:99](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L99)

GET /open/subscriptions 查询参数

## Properties [#properties]

### searchValue? [#searchvalue]

> `optional` &#x2A;*searchValue?**: `string`

Defined in: [types/subscription.ts:100](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L100)

***

### ids? [#ids]

> `optional` &#x2A;*ids?**: `string`

Defined in: [types/subscription.ts:102](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L102)

JSON 数组字符串，如 `"[1,2,3]"`（服务端 JSON.parse 解析）


# LogDetailQuery (/docs/reference/interfaces/LogDetailQuery)



# Interface: LogDetailQuery [#interface-logdetailquery]

Defined in: [types/log.ts:4](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/log.ts#L4)

GET /open/logs/detail 查询参数

## Properties [#properties]

### path? [#path]

> `optional` &#x2A;*path?**: `string`

Defined in: [types/log.ts:5](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/log.ts#L5)

***

### file [#file]

> **file**: `string`

Defined in: [types/log.ts:6](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/log.ts#L6)


# LogFileInfo (/docs/reference/interfaces/LogFileInfo)



# Interface: LogFileInfo [#interface-logfileinfo]

Defined in: [types/cron.ts:188](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L188)

日志文件信息

## Properties [#properties]

### title [#title]

> **title**: `string`

Defined in: [types/cron.ts:189](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L189)

***

### key [#key]

> **key**: `string`

Defined in: [types/cron.ts:190](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L190)

***

### type [#type]

> **type**: `"directory"` | `"file"`

Defined in: [types/cron.ts:191](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L191)

***

### parent [#parent]

> **parent**: `string`

Defined in: [types/cron.ts:192](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L192)

***

### createTime [#createtime]

> **createTime**: `number`

Defined in: [types/cron.ts:193](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L193)

***

### size? [#size]

> `optional` &#x2A;*size?**: `number`

Defined in: [types/cron.ts:194](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L194)

***

### children? [#children]

> `optional` &#x2A;*children?**: `LogFileInfo`\[]

Defined in: [types/cron.ts:195](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L195)


# LogFileQuery (/docs/reference/interfaces/LogFileQuery)



# Interface: LogFileQuery [#interface-logfilequery]

Defined in: [types/log.ts:10](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/log.ts#L10)

GET /open/logs/:file 查询参数

## Properties [#properties]

### path? [#path]

> `optional` &#x2A;*path?**: `string`

Defined in: [types/log.ts:11](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/log.ts#L11)


# MoveCronViewRequest (/docs/reference/interfaces/MoveCronViewRequest)



# Interface: MoveCronViewRequest [#interface-movecronviewrequest]

Defined in: [types/cron.ts:181](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L181)

PUT /open/crons/views/move 移动视图

## Properties [#properties]

### id [#id]

> **id**: `number`

Defined in: [types/cron.ts:182](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L182)

***

### fromIndex [#fromindex]

> **fromIndex**: `number`

Defined in: [types/cron.ts:183](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L183)

***

### toIndex [#toindex]

> **toIndex**: `number`

Defined in: [types/cron.ts:184](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L184)


# MoveEnvRequest (/docs/reference/interfaces/MoveEnvRequest)



# Interface: MoveEnvRequest [#interface-moveenvrequest]

Defined in: [types/env.ts:65](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/env.ts#L65)

PUT /open/envs/:id/move 请求体

## Properties [#properties]

### fromIndex [#fromindex]

> **fromIndex**: `number`

Defined in: [types/env.ts:66](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/env.ts#L66)

***

### toIndex [#toindex]

> **toIndex**: `number`

Defined in: [types/env.ts:67](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/env.ts#L67)


# NotifyRequest (/docs/reference/interfaces/NotifyRequest)



# Interface: NotifyRequest [#interface-notifyrequest]

Defined in: [types/system.ts:25](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/system.ts#L25)

PUT /open/system/notify 发送通知

## Properties [#properties]

### title [#title]

> **title**: `string`

Defined in: [types/system.ts:26](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/system.ts#L26)

***

### content [#content]

> **content**: `string`

Defined in: [types/system.ts:27](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/system.ts#L27)


# QinglongClientOptions (/docs/reference/interfaces/QinglongClientOptions)



# Interface: QinglongClientOptions [#interface-qinglongclientoptions]

Defined in: [types/common.ts:44](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/common.ts#L44)

客户端配置

## Properties [#properties]

### baseUrl [#baseurl]

> **baseUrl**: `string`

Defined in: [types/common.ts:46](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/common.ts#L46)

青龙面板地址，如 [http://localhost:5700](http://localhost:5700) 或 [http://host/ql](http://host/ql)

***

### clientId [#clientid]

> **clientId**: `string`

Defined in: [types/common.ts:48](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/common.ts#L48)

应用 Client ID（系统设置 -> 应用设置）

***

### clientSecret [#clientsecret]

> **clientSecret**: `string`

Defined in: [types/common.ts:50](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/common.ts#L50)

应用 Client Secret

***

### fetch? [#fetch]

> `optional` &#x2A;*fetch?**: (`input`, `init?`) => `Promise`\<`Response`>

Defined in: [types/common.ts:52](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/common.ts#L52)

自定义 fetch 实现，默认使用全局 fetch

[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)

#### Parameters [#parameters]

##### input [#input]

`URL` | `RequestInfo`

##### init? [#init]

`RequestInit`

#### Returns [#returns]

`Promise`\<`Response`>

***

### tokenRefreshBuffer? [#tokenrefreshbuffer]

> `optional` &#x2A;*tokenRefreshBuffer?**: `number`

Defined in: [types/common.ts:54](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/common.ts#L54)

Token 过期前多少秒自动刷新，默认 300（5 分钟）


# QinglongResponse\<T\> (/docs/reference/interfaces/QinglongResponse)



# Interface: QinglongResponse\<T> [#interface-qinglongresponset]

Defined in: [types/common.ts:19](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/common.ts#L19)

青龙统一 API 响应格式

## Type Parameters [#type-parameters]

### T [#t]

`T` = `unknown`

## Properties [#properties]

### code [#code]

> **code**: `number`

Defined in: [types/common.ts:21](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/common.ts#L21)

业务状态码，200 表示成功

***

### data? [#data]

> `optional` &#x2A;*data?**: `T`

Defined in: [types/common.ts:23](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/common.ts#L23)

响应数据

***

### message? [#message]

> `optional` &#x2A;*message?**: `string`

Defined in: [types/common.ts:25](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/common.ts#L25)

错误或提示信息

***

### errors? [#errors]

> `optional` &#x2A;*errors?**: `object`\[]

Defined in: [types/common.ts:27](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/common.ts#L27)

校验错误详情（Celebrate/Joi）

#### message [#message-1]

> **message**: `string`

#### value? [#value]

> `optional` &#x2A;*value?**: `unknown`


# ReloadRequest (/docs/reference/interfaces/ReloadRequest)



# Interface: ReloadRequest [#interface-reloadrequest]

Defined in: [types/system.ts:42](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/system.ts#L42)

PUT /open/system/reload 重载系统

## Properties [#properties]

### type? [#type]

> `optional` &#x2A;*type?**: `string` | `null`

Defined in: [types/system.ts:43](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/system.ts#L43)


# RenameScriptRequest (/docs/reference/interfaces/RenameScriptRequest)



# Interface: RenameScriptRequest [#interface-renamescriptrequest]

Defined in: [types/script.ts:51](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/script.ts#L51)

PUT /open/scripts/rename 重命名

## Properties [#properties]

### filename [#filename]

> **filename**: `string`

Defined in: [types/script.ts:52](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/script.ts#L52)

***

### path? [#path]

> `optional` &#x2A;*path?**: `string`

Defined in: [types/script.ts:53](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/script.ts#L53)

***

### newFilename [#newfilename]

> **newFilename**: `string`

Defined in: [types/script.ts:54](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/script.ts#L54)


# RequestOptions (/docs/reference/interfaces/RequestOptions)



# Interface: RequestOptions [#interface-requestoptions]

Defined in: [types/common.ts:61](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/common.ts#L61)

内部请求选项

## Properties [#properties]

### method? [#method]

> `optional` &#x2A;*method?**: [`HttpMethod`](../type-aliases/HttpMethod)

Defined in: [types/common.ts:62](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/common.ts#L62)

***

### path [#path]

> **path**: `string`

Defined in: [types/common.ts:63](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/common.ts#L63)

***

### query? [#query]

> `optional` &#x2A;*query?**: `object`

Defined in: [types/common.ts:64](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/common.ts#L64)

***

### body? [#body]

> `optional` &#x2A;*body?**: `unknown`

Defined in: [types/common.ts:65](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/common.ts#L65)

***

### auth? [#auth]

> `optional` &#x2A;*auth?**: `boolean`

Defined in: [types/common.ts:66](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/common.ts#L66)

***

### headers? [#headers]

> `optional` &#x2A;*headers?**: `Record`\<`string`, `string`>

Defined in: [types/common.ts:67](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/common.ts#L67)


# ResetAuthRequest (/docs/reference/interfaces/ResetAuthRequest)



# Interface: ResetAuthRequest [#interface-resetauthrequest]

Defined in: [types/system.ts:52](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/system.ts#L52)

PUT /open/system/auth/reset 重置认证

## Properties [#properties]

### retries? [#retries]

> `optional` &#x2A;*retries?**: `number`

Defined in: [types/system.ts:53](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/system.ts#L53)

***

### twoFactorActivated? [#twofactoractivated]

> `optional` &#x2A;*twoFactorActivated?**: `boolean`

Defined in: [types/system.ts:54](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/system.ts#L54)

***

### password? [#password]

> `optional` &#x2A;*password?**: `string`

Defined in: [types/system.ts:55](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/system.ts#L55)

***

### username? [#username]

> `optional` &#x2A;*username?**: `string`

Defined in: [types/system.ts:56](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/system.ts#L56)


# RunScriptRequest (/docs/reference/interfaces/RunScriptRequest)



# Interface: RunScriptRequest [#interface-runscriptrequest]

Defined in: [types/script.ts:37](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/script.ts#L37)

PUT /open/scripts/run 运行脚本

## Properties [#properties]

### filename [#filename]

> **filename**: `string`

Defined in: [types/script.ts:38](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/script.ts#L38)

***

### path? [#path]

> `optional` &#x2A;*path?**: `string`

Defined in: [types/script.ts:39](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/script.ts#L39)

***

### content? [#content]

> `optional` &#x2A;*content?**: `string`

Defined in: [types/script.ts:40](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/script.ts#L40)


# RunningInstance (/docs/reference/interfaces/RunningInstance)



# Interface: RunningInstance [#interface-runninginstance]

Defined in: [types/cron.ts:130](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L130)

运行实例

## Properties [#properties]

### id? [#id]

> `optional` &#x2A;*id?**: `number`

Defined in: [types/cron.ts:131](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L131)

***

### cron\_id [#cron_id]

> **cron\_id**: `number`

Defined in: [types/cron.ts:132](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L132)

***

### pid? [#pid]

> `optional` &#x2A;*pid?**: `number`

Defined in: [types/cron.ts:133](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L133)

***

### log\_path? [#log_path]

> `optional` &#x2A;*log\_path?**: `string`

Defined in: [types/cron.ts:134](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L134)

***

### started\_at [#started_at]

> **started\_at**: `number`

Defined in: [types/cron.ts:135](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L135)

***

### finished\_at? [#finished_at]

> `optional` &#x2A;*finished\_at?**: `number`

Defined in: [types/cron.ts:136](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L136)

***

### status [#status]

> **status**: [`InstanceStatus`](../enumerations/InstanceStatus)

Defined in: [types/cron.ts:137](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L137)

***

### exit\_code? [#exit_code]

> `optional` &#x2A;*exit\_code?**: `number`

Defined in: [types/cron.ts:138](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L138)


# SaveConfigRequest (/docs/reference/interfaces/SaveConfigRequest)



# Interface: SaveConfigRequest [#interface-saveconfigrequest]

Defined in: [types/config.ts:13](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/config.ts#L13)

POST /open/configs/save 保存请求

## Properties [#properties]

### name [#name]

> **name**: `string`

Defined in: [types/config.ts:15](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/config.ts#L15)

配置文件名

***

### content? [#content]

> `optional` &#x2A;*content?**: `string`

Defined in: [types/config.ts:17](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/config.ts#L17)

文件内容


# ScriptDetailQuery (/docs/reference/interfaces/ScriptDetailQuery)



# Interface: ScriptDetailQuery [#interface-scriptdetailquery]

Defined in: [types/script.ts:9](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/script.ts#L9)

GET /open/scripts/detail 查询参数

## Properties [#properties]

### path? [#path]

> `optional` &#x2A;*path?**: `string`

Defined in: [types/script.ts:10](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/script.ts#L10)

***

### file [#file]

> **file**: `string`

Defined in: [types/script.ts:11](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/script.ts#L11)


# SshPullOption (/docs/reference/interfaces/SshPullOption)



# Interface: SshPullOption [#interface-sshpulloption]

Defined in: [types/subscription.ts:29](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L29)

SSH 拉取配置

## Properties [#properties]

### private\_key [#private_key]

> **private\_key**: `string`

Defined in: [types/subscription.ts:30](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L30)


# StopScriptRequest (/docs/reference/interfaces/StopScriptRequest)



# Interface: StopScriptRequest [#interface-stopscriptrequest]

Defined in: [types/script.ts:44](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/script.ts#L44)

PUT /open/scripts/stop 停止脚本

## Properties [#properties]

### filename [#filename]

> **filename**: `string`

Defined in: [types/script.ts:45](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/script.ts#L45)

***

### path? [#path]

> `optional` &#x2A;*path?**: `string`

Defined in: [types/script.ts:46](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/script.ts#L46)

***

### pid? [#pid]

> `optional` &#x2A;*pid?**: `number` | `""`

Defined in: [types/script.ts:47](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/script.ts#L47)


# Subscription (/docs/reference/interfaces/Subscription)



# Interface: Subscription [#interface-subscription]

Defined in: [types/subscription.ts:40](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L40)

订阅实体（对应 back/data/subscription.ts）

## Properties [#properties]

### id? [#id]

> `optional` &#x2A;*id?**: `number`

Defined in: [types/subscription.ts:41](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L41)

***

### name? [#name]

> `optional` &#x2A;*name?**: `string`

Defined in: [types/subscription.ts:42](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L42)

***

### type? [#type]

> `optional` &#x2A;*type?**: [`SubscriptionType`](../type-aliases/SubscriptionType)

Defined in: [types/subscription.ts:44](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L44)

订阅类型

***

### schedule\_type? [#schedule_type]

> `optional` &#x2A;*schedule\_type?**: [`ScheduleType`](../type-aliases/ScheduleType)

Defined in: [types/subscription.ts:45](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L45)

***

### schedule? [#schedule]

> `optional` &#x2A;*schedule?**: `string`

Defined in: [types/subscription.ts:46](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L46)

***

### interval\_schedule? [#interval_schedule]

> `optional` &#x2A;*interval\_schedule?**: [`IntervalSchedule`](IntervalSchedule)

Defined in: [types/subscription.ts:47](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L47)

***

### url? [#url]

> `optional` &#x2A;*url?**: `string`

Defined in: [types/subscription.ts:48](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L48)

***

### whitelist? [#whitelist]

> `optional` &#x2A;*whitelist?**: `string`

Defined in: [types/subscription.ts:49](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L49)

***

### blacklist? [#blacklist]

> `optional` &#x2A;*blacklist?**: `string`

Defined in: [types/subscription.ts:50](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L50)

***

### dependences? [#dependences]

> `optional` &#x2A;*dependences?**: `string`

Defined in: [types/subscription.ts:51](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L51)

***

### branch? [#branch]

> `optional` &#x2A;*branch?**: `string`

Defined in: [types/subscription.ts:52](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L52)

***

### status? [#status]

> `optional` &#x2A;*status?**: [`SubscriptionStatus`](../enumerations/SubscriptionStatus)

Defined in: [types/subscription.ts:53](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L53)

***

### pull\_type? [#pull_type]

> `optional` &#x2A;*pull\_type?**: [`PullType`](../type-aliases/PullType)

Defined in: [types/subscription.ts:54](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L54)

***

### pull\_option? [#pull_option]

> `optional` &#x2A;*pull\_option?**: [`SshPullOption`](SshPullOption) | [`UserPwdPullOption`](UserPwdPullOption)

Defined in: [types/subscription.ts:55](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L55)

***

### pid? [#pid]

> `optional` &#x2A;*pid?**: `number`

Defined in: [types/subscription.ts:56](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L56)

***

### is\_disabled? [#is_disabled]

> `optional` &#x2A;*is\_disabled?**: `0` | `1`

Defined in: [types/subscription.ts:57](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L57)

***

### log\_path? [#log_path]

> `optional` &#x2A;*log\_path?**: `string`

Defined in: [types/subscription.ts:58](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L58)

***

### alias [#alias]

> **alias**: `string`

Defined in: [types/subscription.ts:60](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L60)

别名，创建时必填

***

### command? [#command]

> `optional` &#x2A;*command?**: `string`

Defined in: [types/subscription.ts:61](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L61)

***

### extensions? [#extensions]

> `optional` &#x2A;*extensions?**: `string`

Defined in: [types/subscription.ts:62](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L62)

***

### sub\_before? [#sub_before]

> `optional` &#x2A;*sub\_before?**: `string`

Defined in: [types/subscription.ts:63](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L63)

***

### sub\_after? [#sub_after]

> `optional` &#x2A;*sub\_after?**: `string`

Defined in: [types/subscription.ts:64](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L64)

***

### proxy? [#proxy]

> `optional` &#x2A;*proxy?**: `string`

Defined in: [types/subscription.ts:65](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L65)

***

### autoAddCron? [#autoaddcron]

> `optional` &#x2A;*autoAddCron?**: `0` | `1`

Defined in: [types/subscription.ts:66](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L66)

***

### autoDelCron? [#autodelcron]

> `optional` &#x2A;*autoDelCron?**: `0` | `1`

Defined in: [types/subscription.ts:67](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L67)


# SystemConfig (/docs/reference/interfaces/SystemConfig)



# Interface: SystemConfig [#interface-systemconfig]

Defined in: [types/system.ts:12](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/system.ts#L12)

系统配置（对应 back/data/system.ts SystemConfigInfo）

## Properties [#properties]

### logRemoveFrequency? [#logremovefrequency]

> `optional` &#x2A;*logRemoveFrequency?**: `number`

Defined in: [types/system.ts:13](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/system.ts#L13)

***

### cronConcurrency? [#cronconcurrency]

> `optional` &#x2A;*cronConcurrency?**: `number`

Defined in: [types/system.ts:14](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/system.ts#L14)

***

### dependenceProxy? [#dependenceproxy]

> `optional` &#x2A;*dependenceProxy?**: `string`

Defined in: [types/system.ts:15](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/system.ts#L15)

***

### nodeMirror? [#nodemirror]

> `optional` &#x2A;*nodeMirror?**: `string`

Defined in: [types/system.ts:16](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/system.ts#L16)

***

### pythonMirror? [#pythonmirror]

> `optional` &#x2A;*pythonMirror?**: `string`

Defined in: [types/system.ts:17](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/system.ts#L17)

***

### linuxMirror? [#linuxmirror]

> `optional` &#x2A;*linuxMirror?**: `string`

Defined in: [types/system.ts:18](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/system.ts#L18)

***

### timezone? [#timezone]

> `optional` &#x2A;*timezone?**: `string`

Defined in: [types/system.ts:19](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/system.ts#L19)

***

### globalSshKey? [#globalsshkey]

> `optional` &#x2A;*globalSshKey?**: `string`

Defined in: [types/system.ts:20](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/system.ts#L20)

***

### lang? [#lang]

> `optional` &#x2A;*lang?**: `string`

Defined in: [types/system.ts:21](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/system.ts#L21)


# SystemInfo (/docs/reference/interfaces/SystemInfo)



# Interface: SystemInfo [#interface-systeminfo]

Defined in: [types/system.ts:2](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/system.ts#L2)

系统信息（GET /open/system，无需鉴权）

## Properties [#properties]

### isInitialized [#isinitialized]

> **isInitialized**: `boolean`

Defined in: [types/system.ts:3](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/system.ts#L3)

***

### version [#version]

> **version**: `string`

Defined in: [types/system.ts:4](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/system.ts#L4)

***

### publishTime [#publishtime]

> **publishTime**: `number`

Defined in: [types/system.ts:5](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/system.ts#L5)

***

### branch [#branch]

> **branch**: `string`

Defined in: [types/system.ts:6](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/system.ts#L6)

***

### changeLog [#changelog]

> **changeLog**: `string`

Defined in: [types/system.ts:7](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/system.ts#L7)

***

### changeLogLink [#changeloglink]

> **changeLogLink**: `string`

Defined in: [types/system.ts:8](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/system.ts#L8)


# SystemLogQuery (/docs/reference/interfaces/SystemLogQuery)



# Interface: SystemLogQuery [#interface-systemlogquery]

Defined in: [types/system.ts:60](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/system.ts#L60)

GET /open/system/log 查询参数

## Properties [#properties]

### startTime? [#starttime]

> `optional` &#x2A;*startTime?**: `string`

Defined in: [types/system.ts:61](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/system.ts#L61)

***

### endTime? [#endtime]

> `optional` &#x2A;*endTime?**: `string`

Defined in: [types/system.ts:62](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/system.ts#L62)


# UpdateCronConcurrencyRequest (/docs/reference/interfaces/UpdateCronConcurrencyRequest)



# Interface: UpdateCronConcurrencyRequest [#interface-updatecronconcurrencyrequest]

Defined in: [types/system.ts:70](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/system.ts#L70)

## Properties [#properties]

### cronConcurrency [#cronconcurrency]

> **cronConcurrency**: `number` | `null`

Defined in: [types/system.ts:71](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/system.ts#L71)


# UpdateCronRequest (/docs/reference/interfaces/UpdateCronRequest)



# Interface: UpdateCronRequest [#interface-updatecronrequest]

Defined in: [types/cron.ts:63](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L63)

更新定时任务请求体

## Extends [#extends]

* [`CronMutationRequest`](CronMutationRequest)

## Properties [#properties]

### name? [#name]

> `optional` &#x2A;*name?**: `string`

Defined in: [types/cron.ts:33](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L33)

任务名称

#### Inherited from [#inherited-from]

[`CronMutationRequest`](CronMutationRequest).[`name`](CronMutationRequest#name)

***

### command [#command]

> **command**: `string`

Defined in: [types/cron.ts:35](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L35)

执行的命令或脚本，必填

#### Inherited from [#inherited-from-1]

[`CronMutationRequest`](CronMutationRequest).[`command`](CronMutationRequest#command)

***

### schedule [#schedule]

> **schedule**: `string`

Defined in: [types/cron.ts:40](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L40)

标准 5 位 cron 表达式，或特殊值 once / boot（前缀 @）

#### Remarks [#remarks]

无效的定时规则会被服务端拒绝

#### Inherited from [#inherited-from-2]

[`CronMutationRequest`](CronMutationRequest).[`schedule`](CronMutationRequest#schedule)

***

### labels? [#labels]

> `optional` &#x2A;*labels?**: `string`\[]

Defined in: [types/cron.ts:42](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L42)

标签列表

#### Inherited from [#inherited-from-3]

[`CronMutationRequest`](CronMutationRequest).[`labels`](CronMutationRequest#labels)

***

### sub\_id? [#sub_id]

> `optional` &#x2A;*sub\_id?**: `number` | `null`

Defined in: [types/cron.ts:44](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L44)

关联订阅 ID，null 表示无

#### Inherited from [#inherited-from-4]

[`CronMutationRequest`](CronMutationRequest).[`sub_id`](CronMutationRequest#sub_id)

***

### extra\_schedules? [#extra_schedules]

> `optional` &#x2A;*extra\_schedules?**: [`ExtraSchedule`](ExtraSchedule)\[] | `null`

Defined in: [types/cron.ts:46](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L46)

额外定时规则

#### Inherited from [#inherited-from-5]

[`CronMutationRequest`](CronMutationRequest).[`extra_schedules`](CronMutationRequest#extra_schedules)

***

### task\_before? [#task_before]

> `optional` &#x2A;*task\_before?**: `string` | `null`

Defined in: [types/cron.ts:48](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L48)

任务执行前命令

#### Inherited from [#inherited-from-6]

[`CronMutationRequest`](CronMutationRequest).[`task_before`](CronMutationRequest#task_before)

***

### task\_after? [#task_after]

> `optional` &#x2A;*task\_after?**: `string` | `null`

Defined in: [types/cron.ts:50](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L50)

任务执行后命令

#### Inherited from [#inherited-from-7]

[`CronMutationRequest`](CronMutationRequest).[`task_after`](CronMutationRequest#task_after)

***

### log\_name? [#log_name]

> `optional` &#x2A;*log\_name?**: `string` | `null`

Defined in: [types/cron.ts:55](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L55)

自定义日志路径

#### Remarks [#remarks-1]

相对路径限字母数字下划线连字符；绝对路径须在日志目录内或使用 /dev/null

#### Inherited from [#inherited-from-8]

[`CronMutationRequest`](CronMutationRequest).[`log_name`](CronMutationRequest#log_name)

***

### allow\_multiple\_instances? [#allow_multiple_instances]

> `optional` &#x2A;*allow\_multiple\_instances?**: `0` | `1` | `null`

Defined in: [types/cron.ts:57](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L57)

是否允许多实例：0=否，1=是

#### Inherited from [#inherited-from-9]

[`CronMutationRequest`](CronMutationRequest).[`allow_multiple_instances`](CronMutationRequest#allow_multiple_instances)

***

### work\_dir? [#work_dir]

> `optional` &#x2A;*work\_dir?**: `string` | `null`

Defined in: [types/cron.ts:59](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L59)

工作目录

#### Inherited from [#inherited-from-10]

[`CronMutationRequest`](CronMutationRequest).[`work_dir`](CronMutationRequest#work_dir)

***

### id [#id]

> **id**: `number`

Defined in: [types/cron.ts:64](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L64)


# UpdateCronStatusRequest (/docs/reference/interfaces/UpdateCronStatusRequest)



# Interface: UpdateCronStatusRequest [#interface-updatecronstatusrequest]

Defined in: [types/cron.ts:113](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L113)

PUT /open/crons/status 更新运行状态

## Properties [#properties]

### ids [#ids]

> **ids**: `number`\[]

Defined in: [types/cron.ts:114](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L114)

***

### status [#status]

> **status**: `string`

Defined in: [types/cron.ts:116](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L116)

状态值（字符串形式，服务端会 parseInt）

***

### pid? [#pid]

> `optional` &#x2A;*pid?**: `string` | `null`

Defined in: [types/cron.ts:117](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L117)

***

### log\_path? [#log_path]

> `optional` &#x2A;*log\_path?**: `string` | `null`

Defined in: [types/cron.ts:118](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L118)

***

### last\_running\_time? [#last_running_time]

> `optional` &#x2A;*last\_running\_time?**: `number` | `null`

Defined in: [types/cron.ts:119](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L119)

***

### last\_execution\_time? [#last_execution_time]

> `optional` &#x2A;*last\_execution\_time?**: `number` | `null`

Defined in: [types/cron.ts:120](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L120)


# UpdateCronViewRequest (/docs/reference/interfaces/UpdateCronViewRequest)



# Interface: UpdateCronViewRequest [#interface-updatecronviewrequest]

Defined in: [types/cron.ts:176](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L176)

PUT /open/crons/views 更新视图

## Extends [#extends]

* [`CreateCronViewRequest`](CreateCronViewRequest)

## Properties [#properties]

### name [#name]

> **name**: `string`

Defined in: [types/cron.ts:169](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L169)

#### Inherited from [#inherited-from]

[`CreateCronViewRequest`](CreateCronViewRequest).[`name`](CreateCronViewRequest#name)

***

### sorts? [#sorts]

> `optional` &#x2A;*sorts?**: [`CronViewSort`](CronViewSort)\[] | `null`

Defined in: [types/cron.ts:170](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L170)

#### Inherited from [#inherited-from-1]

[`CreateCronViewRequest`](CreateCronViewRequest).[`sorts`](CreateCronViewRequest#sorts)

***

### filters? [#filters]

> `optional` &#x2A;*filters?**: [`CronViewFilter`](CronViewFilter)\[]

Defined in: [types/cron.ts:171](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L171)

#### Inherited from [#inherited-from-2]

[`CreateCronViewRequest`](CreateCronViewRequest).[`filters`](CreateCronViewRequest#filters)

***

### filterRelation? [#filterrelation]

> `optional` &#x2A;*filterRelation?**: `string`

Defined in: [types/cron.ts:172](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L172)

#### Inherited from [#inherited-from-3]

[`CreateCronViewRequest`](CreateCronViewRequest).[`filterRelation`](CreateCronViewRequest#filterrelation)

***

### id [#id]

> **id**: `number`

Defined in: [types/cron.ts:177](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/cron.ts#L177)


# UpdateDependenceProxyRequest (/docs/reference/interfaces/UpdateDependenceProxyRequest)



# Interface: UpdateDependenceProxyRequest [#interface-updatedependenceproxyrequest]

Defined in: [types/system.ts:74](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/system.ts#L74)

## Properties [#properties]

### dependenceProxy [#dependenceproxy]

> **dependenceProxy**: `string` | `null`

Defined in: [types/system.ts:75](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/system.ts#L75)


# UpdateDependenceRequest (/docs/reference/interfaces/UpdateDependenceRequest)



# Interface: UpdateDependenceRequest [#interface-updatedependencerequest]

Defined in: [types/dependence.ts:46](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/dependence.ts#L46)

PUT /open/dependencies 更新请求

## Properties [#properties]

### id [#id]

> **id**: `number`

Defined in: [types/dependence.ts:47](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/dependence.ts#L47)

***

### name [#name]

> **name**: `string`

Defined in: [types/dependence.ts:48](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/dependence.ts#L48)

***

### type [#type]

> **type**: [`DependenceType`](../enumerations/DependenceType)

Defined in: [types/dependence.ts:49](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/dependence.ts#L49)

***

### remark? [#remark]

> `optional` &#x2A;*remark?**: `string`

Defined in: [types/dependence.ts:50](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/dependence.ts#L50)


# UpdateEnvNamesRequest (/docs/reference/interfaces/UpdateEnvNamesRequest)



# Interface: UpdateEnvNamesRequest [#interface-updateenvnamesrequest]

Defined in: [types/env.ts:71](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/env.ts#L71)

PUT /open/envs/name 批量重命名

## Properties [#properties]

### ids [#ids]

> **ids**: `number`\[]

Defined in: [types/env.ts:72](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/env.ts#L72)

***

### name [#name]

> **name**: `string`

Defined in: [types/env.ts:73](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/env.ts#L73)


# UpdateEnvRequest (/docs/reference/interfaces/UpdateEnvRequest)



# Interface: UpdateEnvRequest [#interface-updateenvrequest]

Defined in: [types/env.ts:50](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/env.ts#L50)

PUT /open/envs 更新请求体

## Properties [#properties]

### id [#id]

> **id**: `number`

Defined in: [types/env.ts:51](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/env.ts#L51)

***

### name [#name]

> **name**: `string`

Defined in: [types/env.ts:52](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/env.ts#L52)

***

### value [#value]

> **value**: `string`

Defined in: [types/env.ts:53](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/env.ts#L53)

***

### remarks? [#remarks]

> `optional` &#x2A;*remarks?**: `string` | `null`

Defined in: [types/env.ts:54](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/env.ts#L54)

***

### labels? [#labels]

> `optional` &#x2A;*labels?**: `string`\[]

Defined in: [types/env.ts:55](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/env.ts#L55)


# UpdateGlobalSshKeyRequest (/docs/reference/interfaces/UpdateGlobalSshKeyRequest)



# Interface: UpdateGlobalSshKeyRequest [#interface-updateglobalsshkeyrequest]

Defined in: [types/system.ts:98](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/system.ts#L98)

## Properties [#properties]

### globalSshKey [#globalsshkey]

> **globalSshKey**: `string` | `null`

Defined in: [types/system.ts:99](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/system.ts#L99)


# UpdateLanguageRequest (/docs/reference/interfaces/UpdateLanguageRequest)



# Interface: UpdateLanguageRequest [#interface-updatelanguagerequest]

Defined in: [types/system.ts:94](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/system.ts#L94)

## Properties [#properties]

### lang [#lang]

> **lang**: `string` | `null`

Defined in: [types/system.ts:95](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/system.ts#L95)


# UpdateLinuxMirrorRequest (/docs/reference/interfaces/UpdateLinuxMirrorRequest)



# Interface: UpdateLinuxMirrorRequest [#interface-updatelinuxmirrorrequest]

Defined in: [types/system.ts:86](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/system.ts#L86)

## Properties [#properties]

### linuxMirror [#linuxmirror]

> **linuxMirror**: `string` | `null`

Defined in: [types/system.ts:87](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/system.ts#L87)


# UpdateLogRemoveFrequencyRequest (/docs/reference/interfaces/UpdateLogRemoveFrequencyRequest)



# Interface: UpdateLogRemoveFrequencyRequest [#interface-updatelogremovefrequencyrequest]

Defined in: [types/system.ts:66](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/system.ts#L66)

各配置项更新请求

## Properties [#properties]

### logRemoveFrequency [#logremovefrequency]

> **logRemoveFrequency**: `number` | `null`

Defined in: [types/system.ts:67](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/system.ts#L67)


# UpdateNodeMirrorRequest (/docs/reference/interfaces/UpdateNodeMirrorRequest)



# Interface: UpdateNodeMirrorRequest [#interface-updatenodemirrorrequest]

Defined in: [types/system.ts:78](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/system.ts#L78)

## Properties [#properties]

### nodeMirror [#nodemirror]

> **nodeMirror**: `string` | `null`

Defined in: [types/system.ts:79](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/system.ts#L79)


# UpdatePythonMirrorRequest (/docs/reference/interfaces/UpdatePythonMirrorRequest)



# Interface: UpdatePythonMirrorRequest [#interface-updatepythonmirrorrequest]

Defined in: [types/system.ts:82](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/system.ts#L82)

## Properties [#properties]

### pythonMirror [#pythonmirror]

> **pythonMirror**: `string` | `null`

Defined in: [types/system.ts:83](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/system.ts#L83)


# UpdateScriptRequest (/docs/reference/interfaces/UpdateScriptRequest)



# Interface: UpdateScriptRequest [#interface-updatescriptrequest]

Defined in: [types/script.ts:25](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/script.ts#L25)

PUT /open/scripts 更新脚本内容

## Properties [#properties]

### filename [#filename]

> **filename**: `string`

Defined in: [types/script.ts:26](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/script.ts#L26)

***

### path? [#path]

> `optional` &#x2A;*path?**: `string`

Defined in: [types/script.ts:27](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/script.ts#L27)

***

### content [#content]

> **content**: `string`

Defined in: [types/script.ts:28](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/script.ts#L28)


# UpdateSubscriptionRequest (/docs/reference/interfaces/UpdateSubscriptionRequest)



# Interface: UpdateSubscriptionRequest [#interface-updatesubscriptionrequest]

Defined in: [types/subscription.ts:94](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L94)

PUT /open/subscriptions 更新请求

## Extends [#extends]

* [`CreateSubscriptionRequest`](CreateSubscriptionRequest)

## Properties [#properties]

### type [#type]

> **type**: `string`

Defined in: [types/subscription.ts:72](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L72)

#### Inherited from [#inherited-from]

[`CreateSubscriptionRequest`](CreateSubscriptionRequest).[`type`](CreateSubscriptionRequest#type)

***

### url [#url]

> **url**: `string`

Defined in: [types/subscription.ts:73](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L73)

#### Inherited from [#inherited-from-1]

[`CreateSubscriptionRequest`](CreateSubscriptionRequest).[`url`](CreateSubscriptionRequest#url)

***

### alias [#alias]

> **alias**: `string`

Defined in: [types/subscription.ts:74](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L74)

#### Inherited from [#inherited-from-2]

[`CreateSubscriptionRequest`](CreateSubscriptionRequest).[`alias`](CreateSubscriptionRequest#alias)

***

### schedule\_type [#schedule_type]

> **schedule\_type**: `string`

Defined in: [types/subscription.ts:75](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L75)

#### Inherited from [#inherited-from-3]

[`CreateSubscriptionRequest`](CreateSubscriptionRequest).[`schedule_type`](CreateSubscriptionRequest#schedule_type)

***

### schedule? [#schedule]

> `optional` &#x2A;*schedule?**: `string` | `null`

Defined in: [types/subscription.ts:76](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L76)

#### Inherited from [#inherited-from-4]

[`CreateSubscriptionRequest`](CreateSubscriptionRequest).[`schedule`](CreateSubscriptionRequest#schedule)

***

### interval\_schedule? [#interval_schedule]

> `optional` &#x2A;*interval\_schedule?**: [`IntervalSchedule`](IntervalSchedule) | `null`

Defined in: [types/subscription.ts:77](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L77)

#### Inherited from [#inherited-from-5]

[`CreateSubscriptionRequest`](CreateSubscriptionRequest).[`interval_schedule`](CreateSubscriptionRequest#interval_schedule)

***

### name? [#name]

> `optional` &#x2A;*name?**: `string` | `null`

Defined in: [types/subscription.ts:78](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L78)

#### Inherited from [#inherited-from-6]

[`CreateSubscriptionRequest`](CreateSubscriptionRequest).[`name`](CreateSubscriptionRequest#name)

***

### whitelist? [#whitelist]

> `optional` &#x2A;*whitelist?**: `string` | `null`

Defined in: [types/subscription.ts:79](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L79)

#### Inherited from [#inherited-from-7]

[`CreateSubscriptionRequest`](CreateSubscriptionRequest).[`whitelist`](CreateSubscriptionRequest#whitelist)

***

### blacklist? [#blacklist]

> `optional` &#x2A;*blacklist?**: `string` | `null`

Defined in: [types/subscription.ts:80](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L80)

#### Inherited from [#inherited-from-8]

[`CreateSubscriptionRequest`](CreateSubscriptionRequest).[`blacklist`](CreateSubscriptionRequest#blacklist)

***

### branch? [#branch]

> `optional` &#x2A;*branch?**: `string` | `null`

Defined in: [types/subscription.ts:81](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L81)

#### Inherited from [#inherited-from-9]

[`CreateSubscriptionRequest`](CreateSubscriptionRequest).[`branch`](CreateSubscriptionRequest#branch)

***

### dependences? [#dependences]

> `optional` &#x2A;*dependences?**: `string` | `null`

Defined in: [types/subscription.ts:82](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L82)

#### Inherited from [#inherited-from-10]

[`CreateSubscriptionRequest`](CreateSubscriptionRequest).[`dependences`](CreateSubscriptionRequest#dependences)

***

### pull\_type? [#pull_type]

> `optional` &#x2A;*pull\_type?**: `string` | `null`

Defined in: [types/subscription.ts:83](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L83)

#### Inherited from [#inherited-from-11]

[`CreateSubscriptionRequest`](CreateSubscriptionRequest).[`pull_type`](CreateSubscriptionRequest#pull_type)

***

### pull\_option? [#pull_option]

> `optional` &#x2A;*pull\_option?**: `Record`\<`string`, `unknown`> | `null`

Defined in: [types/subscription.ts:84](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L84)

#### Inherited from [#inherited-from-12]

[`CreateSubscriptionRequest`](CreateSubscriptionRequest).[`pull_option`](CreateSubscriptionRequest#pull_option)

***

### extensions? [#extensions]

> `optional` &#x2A;*extensions?**: `string` | `null`

Defined in: [types/subscription.ts:85](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L85)

#### Inherited from [#inherited-from-13]

[`CreateSubscriptionRequest`](CreateSubscriptionRequest).[`extensions`](CreateSubscriptionRequest#extensions)

***

### sub\_before? [#sub_before]

> `optional` &#x2A;*sub\_before?**: `string` | `null`

Defined in: [types/subscription.ts:86](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L86)

#### Inherited from [#inherited-from-14]

[`CreateSubscriptionRequest`](CreateSubscriptionRequest).[`sub_before`](CreateSubscriptionRequest#sub_before)

***

### sub\_after? [#sub_after]

> `optional` &#x2A;*sub\_after?**: `string` | `null`

Defined in: [types/subscription.ts:87](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L87)

#### Inherited from [#inherited-from-15]

[`CreateSubscriptionRequest`](CreateSubscriptionRequest).[`sub_after`](CreateSubscriptionRequest#sub_after)

***

### proxy? [#proxy]

> `optional` &#x2A;*proxy?**: `string` | `null`

Defined in: [types/subscription.ts:88](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L88)

#### Inherited from [#inherited-from-16]

[`CreateSubscriptionRequest`](CreateSubscriptionRequest).[`proxy`](CreateSubscriptionRequest#proxy)

***

### autoAddCron? [#autoaddcron]

> `optional` &#x2A;*autoAddCron?**: `boolean` | `null`

Defined in: [types/subscription.ts:89](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L89)

#### Inherited from [#inherited-from-17]

[`CreateSubscriptionRequest`](CreateSubscriptionRequest).[`autoAddCron`](CreateSubscriptionRequest#autoaddcron)

***

### autoDelCron? [#autodelcron]

> `optional` &#x2A;*autoDelCron?**: `boolean` | `null`

Defined in: [types/subscription.ts:90](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L90)

#### Inherited from [#inherited-from-18]

[`CreateSubscriptionRequest`](CreateSubscriptionRequest).[`autoDelCron`](CreateSubscriptionRequest#autodelcron)

***

### id [#id]

> **id**: `number`

Defined in: [types/subscription.ts:95](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L95)


# UpdateSubscriptionStatusRequest (/docs/reference/interfaces/UpdateSubscriptionStatusRequest)



# Interface: UpdateSubscriptionStatusRequest [#interface-updatesubscriptionstatusrequest]

Defined in: [types/subscription.ts:111](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L111)

PUT /open/subscriptions/status 更新状态

## Properties [#properties]

### ids [#ids]

> **ids**: `number`\[]

Defined in: [types/subscription.ts:112](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L112)

***

### status [#status]

> **status**: `string`

Defined in: [types/subscription.ts:113](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L113)

***

### pid? [#pid]

> `optional` &#x2A;*pid?**: `string`

Defined in: [types/subscription.ts:114](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L114)

***

### log\_path? [#log_path]

> `optional` &#x2A;*log\_path?**: `string`

Defined in: [types/subscription.ts:115](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L115)


# UpdateTimezoneRequest (/docs/reference/interfaces/UpdateTimezoneRequest)



# Interface: UpdateTimezoneRequest [#interface-updatetimezonerequest]

Defined in: [types/system.ts:90](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/system.ts#L90)

## Properties [#properties]

### timezone [#timezone]

> **timezone**: `string` | `null`

Defined in: [types/system.ts:91](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/system.ts#L91)


# UserPwdPullOption (/docs/reference/interfaces/UserPwdPullOption)



# Interface: UserPwdPullOption [#interface-userpwdpulloption]

Defined in: [types/subscription.ts:34](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L34)

用户名密码拉取配置

## Properties [#properties]

### username [#username]

> **username**: `string`

Defined in: [types/subscription.ts:35](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L35)

***

### password [#password]

> **password**: `string`

Defined in: [types/subscription.ts:36](https://github.com/siaikin/qinglong-client/blob/ea3963e36fbc0312ca54a6b233dc272e267ded85/src/types/subscription.ts#L36)