CreateCommand--云服务器-火山引擎

文档中心

立即注册

导航

云服务器

CreateCommand

最近更新时间：2024.06.24 15:57:04首次发布时间：2023.09.04 15:43:18

调用CreateCommand接口，新建一条自定义命令。

说明

可通过ParameterDefinitions.N.xxx参数在命令中配置自定义参数，使用规则如下：

参数 - N：表示自定义参数的序号，取值范围：1～60。
多个自定义参数之间用&分隔。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

名称	类型	是否必填	示例值	描述
Action	String	是	CreateCommand	要执行的操作，取值：CreateCommand。
Version	String	是	2020-04-01	接口的版本，取值：2020-04-01。
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：非必填。说明必填时，使用InvokeCommand接口执行命令，需在其`Parameters`参数中传入自定义参数值。
ParameterDefinitions.N.DefaultValue	String	否	ParameterDefinitions.1.DefaultValue=ecs	自定义参数默认值。说明请根据`Type`参数指定的参数类型，填写相应类型的默认值。
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`。
Username	String	否	root	执行命令时的用户名。说明 Linux实例默认执行用户为`root`。
ContentEncoding	String	否	Base64	命令内容是否经过Base64编码处理。取值： Base64（默认）：经过Base64编码处理。 PlainText：未进行编码处理。
CommandContent	String	是	IyEvYmluL2Jhc2gKZWNobyAib3BlcmF0aW9uIHN1Y2Nlc3MhIg==	命令内容。说明请根据`ContentEncoding`参数传入相应命令内容。请确保在编码前的脚本首行，按如下规范指定了脚本解释器。规则如下： Shell脚本：首行需为`#!/bin/bash`。 Python脚本：首行需为`#!/usr/bin/python`。命令内容不能超过16KB。 `EnableParameter=true`时，命令内容支持使用自定义参数。规则如下：自定义参数用`{{}}`包含的方式定义。在`{{}}`内参数名前后的空格以及换行符会被忽略。
WorkingDir	String	否	/home	创建的命令在ECS实例中运行的目录。Linux实例默认为`/home`。
Timeout	Integer	否	60	创建的命令在ECS实例中执行时最大的超时时间，单位为秒。取值范围：30~86400。默认值：60。说明当因为某种原因无法运行创建的命令时，会出现超时现象。超时后，会强制终止命令进程。

返回数据

名称	类型	示例值	描述
CommandId	String	cmd-ycgpkuavyrm0tq****	自定义命令ID。

请求示例

GET /?Action=CreateCommand&Version=2020-04-01&Type=Shell&Name=updateAgent&CommandContent=IyEvYmluL2Jhc2gKCnNzaFB1YmxpY0tleT0ie3tzc2hfcHVibGljX2tleX19IgoKbWtkaXIgLXAgfi8uc3NoICYmIGNobW9kIDcwMCB%2BLy5zc2ggCnRvdWNoIH4vLnNzaC9hdXRob3JpemVkX2tleXMKY2htb2QgNjAwIH4vLnNzaC9hdXRob3JpemVkX2tleXMKZWNobyAkc3NoUHVibGljS2V5ID4%2BIH4vLnNzaC9hdXRob3JpemVkX2tleXMKZWNobyAib3BlcmF0aW9uIHN1Y2Nlc3MhIg%3D%3D HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
Service: ecs

返回示例

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

错误码

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