云服务器
云服务器
文档指南
请输入
- 文档首页
云服务器云服务器ECSAPI参考云助手CreateCommand - 创建自定义命令
复制全文
下载 pdfCreateCommand - 创建自定义命令
文档反馈
问问助手调用CreateCommand接口，新建一条自定义命令。
使用说明
可通过ParameterDefinitions.N.xxx参数在命令中配置自定义参数，使用规则如下：
- 参数 - N：表示自定义参数的序号，取值范围：1～60。
- 多个自定义参数之间用&分隔。
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
Action string 必选 示例值：CreateCommand
要执行的操作，取值：CreateCommand。
Version string 必选 示例值：2020-04-01
API的版本，取值：2020-04-01。
Tags.N.Key string[] 可选 示例值：Tags.1.Key=k1&Tags.2.Key=k2
用户标签的标签键。
- 参数 - N：表示标签键的序号，取值范围：1～20。
- 多个标签键之间用&分隔。
命名规则如下：
- 不能以volc:或sys:的任意大小写组合开头。
- 只能包含语言字符、数字、空格和英文符号“_”、“.”、“:”、“/”、“=”、“+”、“-”、“@”。
- 长度限制在1～128个字符之间。
说明
同一资源的标签键不允许重复。
ProjectName string 可选 示例值：default
资源所属项目，一个资源只能归属于一个项目。
Tags.N.Value string[] 可选 示例值：Tags.1.Value=v1&Tags.2.Value=v2
用户标签的标签值。
- 参数 - N：表示标签值的序号，取值范围：1～20。
- 多个标签值之间用&分隔。
命名规则如下：
- 只能包含语言字符、数字、空格和英文符号“_”、“.”、“:”、“/”、“=”、“+”、“-”、“@”。
- 允许为空，长度限制在0～256个字符之间。
说明
如果传入该参数，则必须先传入Tags.N.Key。
Name string 必选 示例值：updateAgent
命令名称。需符合如下规则：
- 字符长度1~32。
- 不限制特殊字符。
Description string 可选 示例值：This is a new command.
命令描述，默认为空字符串。
- 字符长度0~256。
- 不限制特殊字符。
Type string 必选 示例值：Shell
命令的类型。取值：
- Shell：表示创建一个在Linux实例中运行的Shell脚本。
- Python：表示创建一个Python脚本。
- Bat：表示创建一个Bat脚本。
- PowerShell：表示创建一个PowerShell脚本。
EnableParameter boolean 可选 示例值：false
创建的命令是否使用自定义参数。取值：
- false：默认，表示不使用自定义参数。
- True：表示使用自定义参数。
ParameterDefinitions.N.Name string[] 可选 示例值：ParameterDefinitions.1.Name=dir
自定义参数名称，需要在脚本中通过{{Param}}定义 。命名规则：
- 单个参数名不能超过64字节。
- 遵循Shell变量命名规则，a-zA-Z0-9-_的组合。首个字符不能以数字开头。中间不能有空格，可以使用下划线。
ParameterDefinitions.N.Type string[] 可选 示例值：ParameterDefinitions.1.Type=String
自定义参数类型。取值：
- String：表示自定义参数类型为String（字符串）类型。
- Digit：表示自定义参数类型为Digit（数值）类型。
ParameterDefinitions.N.Required boolean[] 可选 示例值：ParameterDefinitions.1.Required=true
是否必填。取值：
- true：必填。
- false：非必填。
ParameterDefinitions.N.DefaultValue string[] 可选 示例值：ParameterDefinitions.1.DefaultValue=ecs
自定义参数默认值。
ParameterDefinitions.N.MinLength integer[] 可选 示例值：ParameterDefinitions.1.MinLength=1
自定义参数值（字符串）的最小长度。
- MinLength取值范围：1~1000。
- Type=String时必填，且Required参数为true时默认为1。
- 本参数值需小于MaxLength。
ParameterDefinitions.N.MaxLength integer[] 可选 示例值：ParameterDefinitions.1.MaxLength=98
自定义参数值（字符串）的最大长度。
- MaxLength取值范围：1~1000。
- Type=String时必填，且Required参数为true时默认为1000。
- 本参数值需大于MinLength。
ParameterDefinitions.N.MinValue string[] 可选 示例值：ParameterDefinitions.1.MinValue=1
自定义参数值（数值）的最小值。
- MinValue取值范围：-1000000~1000000。
- Type=Digit时必填，且Required参数为true时默认为-1000000。
- 本参数值需小于MaxValue
ParameterDefinitions.N.MaxValue string[] 可选 示例值：ParameterDefinitions.1.MaxValue=100
自定义参数值（数值）的最大值。
- MaxValue取值范围：-1000000~1000000。
- Type=Digit时必填，且Required参数为true时默认为1000000。
- 本参数值需小于MinValue。
ParameterDefinitions.N.DecimalPrecision integer[] 可选 示例值：ParameterDefinitions.1.DecimalPrecision=4
自定义参数值（数值）允许的小数点后位数。
- DecimalPrecision取值范围：0~10。
- Type=Digit时必填，且Required参数为true时默认为0。
CommandContent string 必选 示例值：IyEvYmluL2Jhc2gKZWNobyAib3BlcmF0aW9uIHN1Y2Nlc3MhIg==
命令内容。
- 请根据ContentEncoding参数传入相应命令内容。
- 请确保在编码前的脚本首行，按如下规范指定了脚本解释器。规则如下：
- Shell脚本：首行需为#!/bin/bash。
- Python脚本：首行需为#!/usr/bin/python。
- 命令内容不能超过16KB。
- EnableParameter=true时，命令内容支持使用自定义参数。规则如下：
- 自定义参数用{{}}包含的方式定义。
- 在{{}}内参数名前后的空格以及换行符会被忽略。
WorkingDir string 可选 示例值：/home
创建的命令在ECS实例中运行的目录。Linux实例默认为/home。
Username string 可选 示例值：root
执行命令时的用户名。
Timeout integer 可选 示例值：60
创建的命令在ECS实例中执行时最大的超时时间，单位为秒。
- 取值范围：30~86400。
- 默认值：60。
ContentEncoding string 可选 示例值：Base64
命令内容是否经过Base64编码处理。取值：
- Base64（默认）：经过Base64编码处理。
- PlainText： 未进行编码处理。
返回参数
CommandId string 示例值：cmd-ycgpkuavyrm0tq****
自定义命令ID。
请求示例
返回示例
错误码
最近更新时间：2026.10.09 15:23:54
这个页面对您有帮助吗？
有用
有用
无用
无用