调用ModifyCommand修改一条云助手命令相关参数以及命令内容。

接口说明

命令执行期间也允许修改,修改命令后,后续执行会按照新的命令内容执行。

您不能修改命令的类型,例如,如果命令是Shell命令(RunShellScript),则不能修改为Bat命令(RunBatScript)。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String ModifyCommand

系统规定参数。取值:ModifyCommand

RegionId String cn-hangzhou

地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。

CommandId String c-hz01272yr52****

命令ID。您可以通过接口DescribeCommands查询所有可用的CommandId。

Name String test-CommandName

命令名称。支持全字符集,长度不得超过128个字符。

Description String This is description.

命令描述。支持全字符集,长度不得超过512个字符。

CommandContent String echo

命令内容。命令内容可以是明文内容或Base64编码后的内容。您需要注意:

  • 命令内容在Base64编码后的大小不能超过16 KB。
  • 如果您的命令内容是Base64编码后的内容,则必须设置ContentEncoding=Base64
  • 指定参数EnableParameter=true可在命令内容中启用自定义参数功能:
    • {{}}包含的方式定义自定义参数,在{{}}内参数名前后的空格以及换行符会被忽略。
    • 自定义参数个数不能超过20个。
    • 自定义参数名允许a-zA-Z0-9-_的组合,不支持其余字符,参数名不区分大小写。
    • 单个自定义参数名不能超过64字节。
WorkingDir String /home/

执行路径。

Timeout Long 120

您创建的命令在ECS实例中执行时最大的超时时间,单位为秒。当无法在配置的时间内运行并完成您创建的命令时,会出现超时现象。超时后,会强制终止命令进程,即取消命令的PID。

返回数据

名称 类型 示例值 描述
RequestId String 0DE9B41E-EF0D-40A0-BB43-37749C5BDA9C

请求ID。

示例

请求示例

https://ecs.aliyuncs.com/?Action=ModifyCommand
&CommandId=c-hz01272yr52****
&RegionId=cn-hangzhou
&Name=test-CommandName
&Description=This is description.
&CommandContent=c2VydmljZSB0b21jYXQgc3RhcnQ=
&WorkingDir=/home/
&Timeout=120
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ModifyCommandResponse>
    <RequestId>0DE9B41E-EF0D-40A0-BB43-37749C5BDA9C</RequestId>
</ModifyCommandResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "0DE9B41E-EF0D-40A0-BB43-37749C5BDA9C"
}

错误码

HttpCode 错误码 错误信息 描述
400 RegionId.ApiNotSupported The api is not supported in this region. 指定地域下不支持调用API。请检查RegionId参数取值是否正确。
403 CmdName.Readonly The command name is readonly after publishing. 命令已经发布,禁止修改。
403 CmdName.ExceedLimit The length of the command name exceeds the upper limit. 命令名称长度超过上限。
403 CmdContent.ExceedLimit The length of the command content exceeds the upper limit. 命令内容长度超过上限。
403 CmdDesc.ExceedLimit The length of the command description exceeds the upperlimit. 命令描述长度超过上限。
403 Operation.Forbidden The operation is not permitted. 该操作是不被允许的
404 InvalidCmdId.NotFound The specified command ID does not exist. 指定的CommandId参数有误,请检查参数值是否正确。您可以通过接口DescribeCommands查询所有可用的CommandId。
500 InternalError.Dispatch An error occurred when you dispatched the request. 发送请求时发生错误,请稍后重试。

访问错误中心查看更多错误码。