tencent cloud

APIs

文档APIsTencent Cloud Automation ToolsRemote Command APIsCreateCommand

创建命令

下载
聚焦模式
字号
最后更新时间： 2026-06-09 15:37:24

1. 接口描述

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

此接口用于创建命令。

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：CreateCommand。
Version 是 String 公共参数，本接口取值：2020-10-28。
Region 是 String 公共参数，详见产品支持的 地域列表。
CommandName 是 String

命令名称。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点，最大长度不能超60个字节。
Content 是 String

命令脚本内容。 需 Base64 编码后传入。

当 EnableParameter = true 时，支持两种动态参数占位符：

  • 普通参数 {{key}}：例如脚本 echo {{word}} 配合参数 {"word": "hello"}，实际执行 echo hello，执行记录显示 {"word": "hello"}。
  • 隐藏参数 {{tat-hidden:key}}：用于敏感信息脱敏。例如脚本 echo {{tat-hidden:word}} 配合参数 {"word": "hello"}（传参 Key 不带前缀），实际执行 echo hello，记录显示 {"word": "******"}。

参数格式：Base64 编码字符串

入参限制：Base64 编码后的字符串长度不能超过 64KB
Description 否 String

命令描述。不超过120字符。
CommandType 否 String

命令类型，目前支持取值：SHELL、POWERSHELL、BAT。默认：SHELL。
WorkingDirectory 否 String

命令执行路径，对于 SHELL 命令默认为 /root，对于 POWERSHELL 命令默认为 C:\Program Files\qcloud\tat_agent\workdir。
Timeout 否 Integer

命令超时时间，默认60秒。取值范围[1, 86400]。
EnableParameter 否 Boolean

是否启用自定义参数功能。
一旦创建，此值不提供修改。
默认值：false。
DefaultParameters 否 String

启用自定义参数功能时，自定义参数的默认取值。字段类型为json encoded string。如：{"varA": "222"}。
key为自定义参数名称，value为该参数的默认取值。kv均为字符串型。
如果InvokeCommand时未提供参数取值，将使用这里的默认值进行替换。
参数不支持同时指定 DefaultParameters 和 DefaultParameterConfs 。
仅在 EnableParameter 参数为 true 时，才允许设置此参数。
自定义参数最多20个。
自定义参数名称需符合以下规范：字符数目上限64，可选范围【a-zA-Z0-9-_】。
DefaultParameterConfs.N 否 Array of DefaultParameterConf

自定义参数数组。
如果InvokeCommand时未提供参数取值，将使用这里的默认值进行替换。
参数不支持同时指定 DefaultParameters 和 DefaultParameterConfs 。
仅在 EnableParameter 参数为 true 时，才允许设置此参数。
自定义参数最多20个。
Tags.N 否 Array of Tag

为命令关联的标签，列表长度不超过10。
Username 否 String

在 CVM 或 Lighthouse 实例中执行命令的用户名称。
使用最小权限执行命令是权限管理的最佳实践，建议您以普通用户身份执行云助手命令。默认情况下，在 Linux 实例中以 root 用户执行命令；在Windows 实例中以 System 用户执行命令。
OutputCOSBucketUrl 否 String

指定日志上传的cos bucket 地址，必须以https开头，如 https://BucketName-123454321.cos.ap-beijing.myqcloud.com。
OutputCOSKeyPrefix 否 String

指定日志在cos bucket中的目录，目录命名有如下规则：

  1. 可用数字、中英文和可见字符的组合，长度最多为60。
  2. 用 / 分割路径，可快速创建子目录。
  3. 不允许连续 / ；不允许以 / 开头；不允许以..作为文件夹名称

3. 输出参数

参数名称 类型 描述
CommandId String

命令ID。
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建命令

输入示例

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

{
    "CommandName": "hello-command",
    "Description": "hello world",
    "Content": "bHM=",
    "CommandType": "SHELL",
    "WorkingDirectory": "/tmp",
    "Timeout": 60
}

输出示例

{
    "Response": {
        "RequestId": "9bea970a-0bab-495f-b0dd-de5eedfdf611",
        "CommandId": "cmd-7efujjs6"
    }
}

5. 开发者资源

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.TagOperationFailed 标签操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.CommandContentInvalid Command 内容无效。
InvalidParameterValue.CommandNameDuplicated Command 名称重复。
InvalidParameterValue.InvalidCommandName Command 名称无效。
InvalidParameterValue.InvalidContent 命令内容无效。
InvalidParameterValue.InvalidOutputCOSBucketUrl OutputCOSBucketUrl 无效。
InvalidParameterValue.InvalidOutputCOSKeyPrefix OutputCOSKeyPrefix 无效。
InvalidParameterValue.InvalidUsername 用户名不合法。
InvalidParameterValue.InvalidWorkingDirectory 命令执行路径不合法。
InvalidParameterValue.ParameterDisabled 未启用自定义参数功能。
InvalidParameterValue.ParameterInvalidJsonFormat 参数为非法 json string 格式。
InvalidParameterValue.ParameterKeyContainsInvalidChar 参数 Key 包含非法字符。
InvalidParameterValue.ParameterKeyDuplicated 参数 Key 重复。
InvalidParameterValue.ParameterKeyLenExceeded 参数 Key 过长。
InvalidParameterValue.ParameterNumberExceeded 参数数目过多。
InvalidParameterValue.ParameterValueNotString 参数 Value 非 string 类型。
InvalidParameterValue.Range 参数取值范围不合法。
InvalidParameterValue.SupportParametersOnlyIfEnableParameter 未启用自定义参数功能。
InvalidParameterValue.TooLong 长度超过限制。
MissingParameter 缺少参数错误。
ResourceNotFound.CosBucketNotFoundCode CosBucket不存在。
ResourceUnavailable.UserHasNoQuotaCode 用户配额已用完
UnauthorizedOperation.CamAuthFailed CAM鉴权失败。
UnauthorizedOperation.InvalidToken Token 无效。
UnauthorizedOperation.MFAExpired Multi-Factor Authentication(MFA) 过期。
UnauthorizedOperation.MFANotFound Multi-Factor Authentication(MFA) 不存在。
UnsupportedOperation 操作不支持。
上一篇: Responses下一篇: ModifyCommand

帮助和支持

本页内容是否解决了您的问题？

填写满意度调查问卷，共创更好文档体验。

文档反馈