调用ModifyCommand修改一条云助手命令相关参数。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| ecs:ModifyCommand | update | *Command acs:ecs:{#regionId}:{#accountId}:command/{#commandId} |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
| CommandId | string | 是 | 命令 ID。您可以通过接口 DescribeCommands 查询所有可用的 CommandId。 | c-hz01272yr52**** |
| Name | string | 否 | 命令名称。支持全字符集，长度不得超过 128 个字符。 | test-CommandName |
| Description | string | 否 | 命令描述。支持全字符集，长度不得超过 512 个字符。 | This is description. |
| CommandContent | string | 否 | 说明
该参数已废弃，传入该参数不会生效。
| echo |
| WorkingDir | string | 否 | 执行路径。长度不得超过 200 个字符。 | /home/ |
| Timeout | long | 否 | 您创建的命令在 ECS 实例中执行时最大的超时时间，单位为秒。当无法在配置的时间内运行并完成您创建的命令时，会出现超时现象。超时后，会强制终止命令进程，即取消命令的 PID。 | 120 |
| Launcher | string | 否 | 脚本执行的引导程序。长度不能超过 1 KB。 | python3 -u {{ACS::ScriptFileName|Ext(".py")}} |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "0DE9B41E-EF0D-40A0-BB43-37749C5BDA9C"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | RegionId.ApiNotSupported | The api is not supported in this region. | 指定地域下不支持调用 API。请检查 RegionId 参数取值是否正确。 |
| 400 | InvalidParameter.WorkingDir | The specified parameter WorkingDir is not valid. | 指定的参数WorkingDir不合法。 |
| 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. | 该操作是不被允许的。 |
| 403 | InvalidParameterCharacter.CommandName | The command Name contains illegal characters. | 命令名称包含非法字符。 |
| 403 | InvalidParameterCharacter.CommandDescription | The command Description contains illegal characters. | 命令描述包含非法字符。 |
| 403 | InvalidParameterCharacter.CommandWorkingDir | The command WorkingDir contains illegal characters. | 命令执行路径包含非法字符。 |
| 403 | InvalidLauncher.LengthLimitExceeded | The length of the parameter Launcher exceeds the limit of 1 KB characters. | 参数Launcher的长度超过了 1 KB个字符的限制。 |
| 404 | InvalidRegionId.NotFound | The RegionId provided does not exist in our records. | 提供的RegionId不存在 |
| 404 | InvalidCmdId.NotFound | The specified command ID does not exist. | 指定的 CommandId 参数有误，请检查参数值是否正确。您可以通过接口 DescribeCommands 查询所有可用的 CommandId。 |
| 500 | InternalError.Dispatch | An error occurred when you dispatched the request. | 发送请求时发生错误，请稍后重试。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-10-29 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
| 2024-05-11 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2023-05-12 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2022-02-23 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2022-02-23 | OpenAPI 错误码发生变更 | 查看变更详情 |