RunCommand_轻量应用服务器_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

命令助手是专为轻量应用服务器打造的自动化运维工具。您无需登录,即可在控制台上通过命令(Shell、Powershell 和 Bat)对轻量应用服务器实例进行运维管理操作。

使用命令助手时,需满足以下条件:

  • 轻量应用服务器实例的状态必须为运行中。
  • 已安装云助手客户端。轻量应用服务器实例默认已安装云助手客户端,如果您手动卸载,需重新安装。具体操作,请参见安装云助手客户端

流控信息

请求速率为1000/60(s)。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
swas-open:RunCommand
Create
Command
acs:swas-open:{#regionId}:{#accountId}:{#CommandId}

请求参数

字段名称字段详情
CommandContentstring

命令内容。您需要注意:展开详情

示例值:ifconfig -s
WorkingDirstring

您可自定义命令的执行路径。默认路径如下:展开详情

示例值:/root
RegionIdstring

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

示例值:cn-hangzhou参考取值来源:
    ListRegions
Timeoutinteger<int32>

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

示例值:60
Typestring

命令的语言类型。取值范围:展开详情

示例值:RunShellScript
EnableParameterboolean

命令中是否包含自定义参数。展开详情

示例值:false
Parametersobject

命令中包含自定义参数时,执行命令时传入的自定义参数的键值对。例如,命令内容为echo {{name}},则可以通过Parameters参数传入键值对{"name":"Jack"}。自定义参数将自动替换变量值name,得到一条新的命令,实际执行的是echo Jack展开详情

示例值:{"name":"Jack", "accessKey":"LTAI****************"}
WorkingUserstring

您可以指定以某个轻量应用服务器实例中存在的用户执行命令,建议使用普通用户执行命令可降低安全风险。展开详情

示例值:root
WindowsPasswordNamestring

Windows 实例中执行命令的用户的密码名称。展开详情

示例值:axtSecretPassword
InstanceIdstring

轻量应用云服务器实例 ID。

示例值:ace0706b2ac4454d984295a94213****参考取值来源:
    ListInstances
    CreateInstances
    DescribeDatabaseInstances
Namestring

执行命令名称。

示例值:testName

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
InvokeIdstring

命令执行 ID。

示例值:t-hz02p9545t6****

返回示例

变更历史

变更时间变更内容概要操作
2022-06-21
新增OpenAPI,执行命令

相关示例