You need to enable JavaScript to run this app.
导航
ModifyCommand
最近更新时间:2024.06.13 14:26:06首次发布时间:2023.09.04 15:43:18

调用ModifyCommand接口,修改指定自定义命令内容。

说明

  • 命令执行期间也允许修改,修改命令后,后续执行会按照新的命令内容执行。
  • 可通过ParameterDefinitions.N.xxx参数在命令中配置自定义参数,使用规则如下:
    • 参数 - N:表示自定义参数的序号,取值范围:1~60。
    • 多个自定义参数之间用&分隔。

调试

请求参数

名称类型是否必填示例值描述
ActionStringModifyCommand要执行的操作,取值:ModifyCommand。
VersionString2020-04-01接口的版本,取值:2020-04-01。
CommandIdStringcmd-hz0127****自定义命令ID。可通过DescribeCommands接口查询获取。

Name

String

UpdateAgent

命令名称。默认空,表示保持原有名称不变。

  • 字符长度1~32。
  • 不限制特殊字符。

Type

String

Shell

命令类型。取值支持:

  • Shell:表示脚本类型为Shell。
  • Python:表示脚本类型为Python。
  • Bat:表示创建一个Bat脚本。
  • PowerShell:表示创建一个PowerShell脚本。

Description

String

This is description.

命令描述,默认为空,表示保持原有描述不变。

  • 字符长度0~256。
  • 不限制特殊字符。

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=Shell

参数类型。取值:

  • String:表示自定义参数类型为String(字符串)类型。
  • Digit:表示自定义参数类型为Digit(数值)类型。

ParameterDefinitions.N.Required

Boolean

ParameterDefinitions.1.Required=true

是否必填。取值:

  • true:必填。
  • false:非必填。

说明

必填时,使用InvokeCommand接口执行命令,需在其Parameters参数中传入自定义参数值。

ParameterDefinitions.N.DefaultValue

String

ParameterDefinitions.1.DefaultValue=ecs

自定义参数默认值。

说明

请根据Type参数指定的参数类型,填写相应类型的默认值。

ParameterDefinitions.N.MinLength

Integer

ParameterDefinitions.1.MinLength=1

自定义参数值(字符串)的最小长度。

说明

  • MinLength取值范围:1~100。
  • Type=String时必填,且Required参数为true时默认为1
  • 本参数值需小于MaxLength

ParameterDefinitions.N.MaxLength

Integer

ParameterDefinitions.1.MaxLength=98

自定义参数值(字符串)的最大长度。

说明

  • MaxLength取值范围:1~100。
  • Type=String时必填,且Required参数为true时默认为100
  • 本参数值需大于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

Username

String

root

执行命令时的用户名。

说明

Linux实例默认执行用户为root

WorkingDirString/home创建的命令在ECS实例中运行的目录。 Linux实例默认路径为/home

Timeout

Integer

60

创建的命令在ECS实例中执行时最大的超时时间,单位为

  • 取值范围:30~86400。
  • 默认值:60。

说明

当因为某种原因无法运行创建的命令时,会出现超时现象。超时后,会强制终止命令进程。

ContentEncoding

String

Base64

命令内容是否经过Base64编码处理。取值:

  • Base64(默认):经过Base64编码处理。
  • PlainText: 未进行编码处理。

CommandContent

String

IyEvYmluL2Jhc2gKZWNobyAib3BlcmF0aW9uIHN1Y2Nlc3MhIg==

将命令内容进行Base64编码得到的内容。

说明

  • 请根据ContentEncoding参数传入相应命令内容。
  • 请确保编码前的脚本,首行指定了脚本解释器。规则如下:
    • Shell脚本:首行需为#!/bin/bash
    • Python脚本:首行需为#!/usr/bin/python
  • 命令内容不能超过16KB。
  • EnableParameter=true时,命令内容支持使用自定义参数。规则如下:
    • 自定义参数用{{}}包含的方式定义。
    • {{}}内参数名前后的空格以及换行符会被忽略。

返回数据

名称类型示例值描述
CommandIdStringcmd-hz0127****自定义命令ID。

请求示例

GET /?Action=ModifyCommand&Version=2020-04-01&CommandId=cmd-hz0127****&Name=UpdateAgent HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
Service: ecs

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202106111445100102252431000052****",
        "Action": "ModifyCommand",
        "Version": "2020-04-01",
        "Service": "ecs",
        "Region": "cn-beijing"
    },
    "Result": {
        "CommandId": "cmd-hz0127****"
    }
}

错误码

您可访问公共错误码,获取更多错误码信息。