接口请求域名: tat.tencentcloudapi.com 。
此接口用于创建命令。
默认接口请求频率限制:20次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateCommand。 |
Version | 是 | String | 公共参数,本接口取值:2020-10-28。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
CommandName | 是 | String | 命令名称。名称仅支持中文、英文、数字、下划线、分隔符"-"、小数点,最大长度不能超60个字节。 |
Content | 是 | String | Base64编码后的命令内容,长度不可超过64KB。 |
Description | 否 | String | 命令描述。不超过120字符。 |
CommandType | 否 | String | 命令类型,目前仅支持取值:SHELL。默认:SHELL。 |
WorkingDirectory | 否 | String | 命令执行路径,默认:/root。 |
Timeout | 否 | Integer | 命令超时时间,默认60秒。取值范围[1, 86400]。 |
EnableParameter | 否 | Boolean | 是否启用自定义参数功能。 一旦创建,此值不提供修改。 默认值:false。 |
DefaultParameters | 否 | String | 启用自定义参数功能时,自定义参数的默认取值。字段类型为json encoded string。如:{\"varA\": \"222\"}。 key为自定义参数名称,value为该参数的默认取值。kv均为字符串型。 如果InvokeCommand时未提供参数取值,将使用这里的默认值进行替换。 自定义参数最多20个。 自定义参数名称需符合以下规范:字符数目上限64,可选范围【a-zA-Z0-9-_】。 |
参数名称 | 类型 | 描述 |
---|---|---|
CommandId | String | 命令ID。 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
POST / HTTP/1.1
Host: tat.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCommand
<公共请求参数>
{
"CommandName": "hello-command",
"Description": "hello world",
"Content": "bHM=",
"CommandType": "SHELL",
"WorkingDirectory": "/",
"Timeout": 60
}
{
"Response": {
"RequestId": "9bea970a-0bab-495f-b0dd-de5eedfdf611",
"CommandId": "cmd-7efujjs6"
}
}
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.CommandContentInvalid | Command 内容无效。 |
InvalidParameterValue.CommandNameDuplicated | Command 名称重复。 |
InvalidParameterValue.InvalidCommandName | Command 名称无效。 |
InvalidParameterValue.ParameterInvalidJsonFormat | 参数为非法 json string 格式。 |
InvalidParameterValue.ParameterKeyContainsInvalidChar | 参数 Key 包含非法字符。 |
InvalidParameterValue.ParameterKeyDuplicated | 参数 Key 重复。 |
InvalidParameterValue.ParameterKeyLenExceeded | 参数 Key 过长。 |
InvalidParameterValue.ParameterNumberExceeded | 参数数目过多。 |
InvalidParameterValue.ParameterValueNotString | 参数 Value 非 string 类型。 |
InvalidParameterValue.Range | 参数取值范围不合法。 |
InvalidParameterValue.SupportParametersOnlyIfEnableParameter | 未启用自定义参数功能。 |
MissingParameter | 缺少参数错误。 |
近年来,企业为了在市场中获得优势,越来越需要从不断增长的数据量中挖掘出更深...
本文转载自微信公众号「 无敌码农」,作者 无敌码农 。转载本文请联系 无敌码农...
2月8日,阿里云宣布推出第七代ECS云服务器产品家族,基于最新的神龙架构,相较于...
工业和信息化部财务司联合办公厅、电子司、中国信息通信研究院等单位于2020年11...
新的集成解决方案帮助企业在Oracle云基础设施、多云环境和本地部署的环境,都能...
通过Packer,您只需在JSON配置文件中指明构建镜像所需的基本信息、以及需要安装...
本文转载自微信公众号「大数据DT(ID:hzdashuju)」,作者朱凯。转载本文请联系...
本文转载自微信公众号「大迁世界」,可以通过以下二维码关注。转载本文请联系大...
哪里可以免费申请二级 域名 ?申请免费的二级域名,通常先有顶级域名(一级域名...
艾薇巴蒂!社区的活动一波又一波!就在前几天 【玩转腾讯云】之视频征稿活动 已...