概述
自动化助手（TencentCloud Automation Tools，TAT）是云服务器 CVM 和轻量应用服务器 Lighthouse 的原生运维部署工具。自动化助手提供了一种自动化的远程操作方式，无需登录及密码，即可批量执行命令（Shell、PowerShell 等），完成运行自动化运维脚本、轮询进程、安装/卸载软件、更新应用及安装补丁等任务。
本章节介绍的 TAT 自动化助手 API 接口均为 API 3.0 接口。
您可以调用 API 对 TAT 进行操作，例如创建命令、执行命令等。
TAT 支持的所有接口信息，请参见 API 概览。
术语表
TAT API 接口的常见术语请参见下表：
| 术语 | 描述 |
|---|---|
| 客户端（agent） | 客户端是在用户服务器上运行的名为 tat_agent 的服务程序，TAT 依赖客户端与服务端进行交互来实现功能。可通过 DescribeAutomationAgentStatus 接口查询实例的客户端状态。客户端代码开源，若实例客户端不在线，可按指引安装客户端。 |
| 命令（command） | 命令是可通过 TAT 下发到目标服务器上执行的脚本。命令 ID 以 cmd- 开头，后跟 8 位中英文字符。可通过 DescribeCommands 查询命令详情。 |
| 个人命令（normal command） | 个人命令是用户通过 CreateCommand 接口创建的可复用的脚本，可使用 InvokeCommand 接口将个人命令下发到指定实例中运行。 |
| 公共命令（public command） | 公共命令是 TAT 官方提供的一系列预设脚本，涵盖多种常用运维操作，可使用 InvokeCommand 接口将公共命令下发到指定实例中运行。可通过 DescribeCommands 接口指定 created-by 为 TAT 的 Filter 参数查询公共命令。 |
| 临时命令（temporary command） | 临时命令是通过 RunCommand 接口下发到服务器上执行的脚本。TAT 不会保存临时命令，在命令执行完成后将立即删除。 |
| 执行（invocation） | 执行表示一次执行命令的动作。执行 ID 以 inv- 开头，后跟 10 位中英文字符。每次通过 InvokeCommand 或 RunCommand 接口下发命令时，均会生成一个执行。可通过 DescribeInvocations 接口查询执行详情。 |
| 任务（invocation task） | 任务是命令在单台实例上的具体执行过程。任务 ID 以 invt- 开头，后跟 10 位中英文字符。每次执行命令可以指定多台实例，每台实例都会生成一个独立的任务。可通过 DescribeInvocationTasks 查询任务详情。 |
| 托管实例（register instance） | 托管实例是通过 TAT 注册到腾讯云上的实例，用于使用 TAT 对非腾讯云机器、跨账号或跨地域机器进行统一运维管理。托管实例 ID 以 rins- 开头，后跟 8 位中英文字符。可按指引注册托管实例，注册后可通过 DescribeRegisterInstances 接口查询托管实例详情。 |
| 注册码（register code） | 注册码是一个键值对，用于将实例注册到指定地域。可通过 CreateRegisterCode 接口创建注册码，并通过 DescribeRegisterCodes 接口查询现有的注册码。 |
| 执行器（invoker） | 执行器是用于定时执行命令的控制器，支持对命令延迟执行或定时循环执行。执行器 ID 以 ivk- 开头，后跟 8 位中英文字符。可通过 CreateInvoker 接口创建执行器。 |
| 场景（scene） | 场景是对资源的类别划分，目前仅用于对公共命令进行分类，尚不支持用户自定义。命令 ID 以 sc- 开头，后跟 8 位中英文字符。可通过 DescribeScenes 查询场景信息。 |
使用限制
只有 TAT 客户端为在线状态的实例才能进行执行命令、免密登陆等操作。若实例客户端不在线，可按指引安装客户端。
以下几个场景不支持安装 TAT 客户端：
- 基础网络实例。
- 不支持的操作系统（FreeBSD、Windows Server 2008 等）。
- 网络不通，证书过期、损坏等。
TAT 是严格按地域部署的服务，只能在支持的地域提供服务，可通过 DescribeRegions 接口查询支持的地域。TAT 各地域之间数据不互通，无法访问其他地域的资源。若希望跨地域管理实例，可通过注册托管实例将实例注册到同一地域。
TAT 执行命令时，命令的脚本内容在 Base64 编码后不得多于 64KB；命令的执行输出明文最多保存 24KB，超过限制的内容将被丢弃，若需要保存完整输出，可配置将命令完整输出上传至COS。命令的执行记录只保存 3 个月，同一个账号下最多保存 10 万条执行记录，超出限制的执行记录会被定期清理。
TAT 对部分资源有配额限制，数量达到配额上线后将无法创建资源。目前，命令默认配额为 500 条，注册码默认配额为 5000 条。如需提升配额，请提交工单。
API 快速入门
您可以使用 API Explorer 工具在线调用 API。
本文以执行命令为例，通过 API Explorer 工具调用 API 接口的步骤如下：
- 进入 API Explorer 工具页面。更多 API Explorer 工具使用信息，请参见 使用 API Explorer。
- 调用 CreateCommand 创建自定义命令。
- 调用 DescribeAutomationAgentStatus 查询实例的客户端详情，判断实例客户端是否在线。
- 调用 InvokeCommand 对指定实例执行已创建的命令。
- 调用 DescribeInvocations 查看该次执行的总体状态。
- 调用 DescribeInvocationTasks 查看每个实例的任务细节、脚本执行输出等。
