文档

CreateCommand - 创建命令

更新时间:

新建一条命令助手命令。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
swas-open:CreateCommandcreate
  • Command
    acs:swas-open:{#regionId}:{#accountId}:command/*

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID。您可以调用 ListRegions 查询可用地域。

cn-hangzhou
Namestring

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

testName
Descriptionstring

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

test
Typestring

命令的语言类型。取值范围:

  • RunBatScript:适用于 Windows 实例的 Bat 命令。
  • RunPowerShellScript:适用于 Windows 实例的 PowerShell 命令。
  • RunShellScript:适用于 Linux 实例 Shell 命令。
RunShellScript
CommandContentstring

命令内容。您需要注意:

  • 指定参数EnableParameter=true可在命令内容中启用自定义参数功能:
  • 用{{}}包含的方式定义自定义参数,在{{}}内参数名前后的空格以及换行符会被忽略。
  • 自定义参数个数不能超过 20 个。
  • 自定义参数名允许 a-zA-Z0-9-_的组合,不支持其余字符,参数名不区分大小写。
  • 单个自定义参数名不能超过 64 字节。
ifconfig -s
WorkingDirstring

您创建的命令在 ECS 实例中运行的目录。

默认值:

  • Linux 实例:管理员 root 用户的 home 目录下,具体为/root目录。
  • Windows 实例:云助手客户端进程所在目录,例如C:\Windows\System32
/root/
Timeoutlong

设置命令在服务器实例中的超时时间,单位为秒。

当执行命令的任务超时后,命令助手将强制终止任务进程。可设定超时时间取值范围为 10~86400 秒(24 小时)。

默认值:60。

60
EnableParameterboolean

创建的命令是否使用自定义参数。

默认值为 false。

false
Tagarray<object>

标签列表,最多包含 20 个子项。

object

标签。

Keystring

为命令指定的标签键。N 的取值范围:1~20。

一旦传入该值,则不允许为空字符串。最多支持 64 个字符,不能以 aliyun 和 acs:开头,不能包含 http://或者 https://。

TestKey
Valuestring

为命令指定的标签值。N 的取值范围:1~20。

一旦传入该值,可以为空字符串。最多支持 64 个字符,不能包含 http://或者 https://。

TestValue
ResourceGroupIdstring

资源组 ID。

rg-aek2bti7cf7****

返回参数

名称类型描述示例值
object

Schema of Response.

RequestIdstring

请求 ID。

20758A-585D-4A41-A9B2-28DA8F4****
CommandIdstring

命令 ID。

c-sh02yh0932w****

示例

正常返回示例

JSON格式

{
  "RequestId": "20758A-585D-4A41-A9B2-28DA8F4****",
  "CommandId": "c-sh02yh0932w****"
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-05-29OpenAPI 入参发生变更查看变更详情
2024-02-20OpenAPI 入参发生变更查看变更详情