腾讯云自动化助手 执行命令 - API 文档

1. 接口描述

接口请求域名： tat.tencentcloudapi.com 。

执行命令，调用成功返回执行活动ID（inv-xxxxxxxx），每个执行活动内部有一个或多个执行任务（invt-xxxxxxxx），每个执行任务代表命令在一台 CVM 或一台 Lighthouse 上的执行记录。

• 如果指定实例未安装 agent，或 agent 不在线，返回失败
• 如果命令类型与 agent 运行环境不符，返回失败
• 指定的实例需要处于 VPC 网络
• 指定的实例需要处于 RUNNING 状态
• 不可同时指定 CVM 和 Lighthouse

默认接口请求频率限制：20次/秒。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

3. 输出参数

4. 示例

示例1 在 CVM 批量执行命令

输入示例

POST / HTTP/1.1
Host: tat.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RunCommand
<公共请求参数>

{
    "CommandName": "run-command",
    "SaveCommand": false,
    "Description": "whoami",
    "Content": "d2hvYW1p",
    "CommandType": "SHELL",
    "WorkingDirectory": "/root/",
    "Timeout": 60,
    "InstanceIds": [
        "ins-zj0f57ew",
        "ins-zj0f57ex",
        "ins-zj0f57ev"
    ]
}

输出示例

{
  "Response": {
    "RequestId": "f3e3a951-56b1-4042-af23-ba50223a8f60",
    "CommandId": "cmd-5oa8jajm",
    "InvocationId": "inv-mp6m9vmu"
  }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

• Tencent Cloud SDK 3.0 for Python
• Tencent Cloud SDK 3.0 for Java
• Tencent Cloud SDK 3.0 for PHP
• Tencent Cloud SDK 3.0 for Go
• Tencent Cloud SDK 3.0 for NodeJS
• Tencent Cloud SDK 3.0 for .NET
• Tencent Cloud SDK 3.0 for C++
• Tencent Cloud SDK 3.0 for Ruby

命令行工具

• Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。