> For the complete documentation index, see [llms.txt](https://docs.verge.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.verge.io/knowledge-base/zh/automation-api.md).

# 自动化与 API

* [API 指南](/knowledge-base/zh/automation-api/verge-api-guide.md) — VergeOS API 使用综合指南，涵盖身份验证、HTTP 方法、端点约定、筛选、排序、错误…
* [API 辅助脚本](/knowledge-base/zh/automation-api/api-helper-script.md) — 使用 VergeOS yb-api 辅助脚本简化 API 交互的指南，包括列出、创建、克隆和管理…
* [API 表说明](/knowledge-base/zh/automation-api/api-tables-description.md) — 所有 VergeOS API 表及其简要说明的参考，涵盖计费、目录、集群、证书等资源…
* [自动化任务示例 - 按需自动开启/关闭虚拟机](/knowledge-base/zh/automation-api/automated-task-example-1.md) — 自动化任务的配置示例：当指定用户登录时启动虚拟机，并在…时将其关闭，以节省资源。
* [自动化任务示例 - 在发生同步错误时发送 Slack 频道和电子邮件警报](/knowledge-base/zh/automation-api/automated-task-example-webhook.md) — 自动化示例，展示在遇到同步错误时发送电子邮件警报和 Slack 频道通知的具体配置。
* [使用 API 强制关闭虚拟机](/knowledge-base/zh/automation-api/force-power-off-vm-using-api.md) — 使用 VergeOS API 和 Swagger 界面强制关闭无响应虚拟机的分步说明，包括…
* [影响虚拟机节点选择的设置](/knowledge-base/zh/automation-api/determine-node-where-vm-runs.md) — 说明控制虚拟机运行节点的选项，包括 HA 组亲和性和反亲和性、首选节点、首选集群…
* [Terraform VergeIO 提供程序](/knowledge-base/zh/automation-api/terraform-vergeio-provider.md) — 了解如何使用 VergeIO Terraform Provider 以编程方式管理 VergeOS 资源。
* [虚拟机高级操作 API](/knowledge-base/zh/automation-api/vm-advanced-operations.md) — VergeOS 中虚拟机高级操作的完整指南，包括克隆、快照、删除和故障排查
* [虚拟机配置 API](/knowledge-base/zh/automation-api/vm-configuration.md) — VergeOS 中修改虚拟机配置的完整指南，包括 CPU/RAM 更新、备注、磁盘管理和网络接口…
* [虚拟机创建 API](/knowledge-base/zh/automation-api/vm-creation-api.md) — VergeOS 中创建虚拟机的完整指南，包括基础创建、基于配方的配置、磁盘、设备和网络…
* [虚拟机生命周期管理 API 概览](/knowledge-base/zh/automation-api/vm-lifecycle-management.md) — VergeOS 中虚拟机生命周期管理的完整 REST API 指南——以编程方式创建、管理、配置和删除虚拟机
* [虚拟机电源管理 API](/knowledge-base/zh/automation-api/vm-power-management.md) — VergeOS 中管理虚拟机电源状态的完整指南，包括启动、停止、重启和监控电源状态


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.verge.io/knowledge-base/zh/automation-api.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.