InvokeCommand_轻量应用服务器_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.

接口说明

  • 对目标轻量应用服务器有如下限制,当您选择多台轻量应用服务器后,若其中某台轻量应用服务器不满足执行条件,需要重新调用该接口。
    • 服务器状态必须为运行中(Running),您可以调用 ListInstances 查询。
    • 已预先安装云助手 Agent
    • 执行类型为 PowerShell 的命令时,必须已经配置了 PowerShell 模块。
  • 命令可能会因为目标服务器的状态异常,网络异常或云助手 Agent 异常而出现无法执行的情况,无法执行不会生成执行信息。
  • 当您创建命令启用了自定义参数时,需要在执行命令时传入自定义参数(Parameters)。
  • 调用此接口时您只能选择一条公共命令或您创建的自定义命令。

流控信息

当前云产品API请求速率暂未透出。

授权信息

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

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
swas-open:InvokeCommand
None
全部资源
*

请求参数

字段名称字段详情
RegionIdstring

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

示例值:cn-hangzhou 参考取值来源:
    ListRegions
CommandIdstring

命令 ID。您可以通过接口 DescribeCommands 查询所有可用的 CommandId。

示例值:c-sh02yh0932w****参考取值来源:
    CreateCommand
    DescribeCommands
Parametersobject

启用自定义参数功能时,执行命令时传入的自定义参数的键值对。展开详情

示例值:{"delayed_insert_timeout":"600","max_length_for_sort_data":"2048"}
Usernamestring

在轻量应用服务器中执行命令的用户名称。长度不得超过 255 个字符。展开详情

示例值:test
InstanceIdsstring

轻量应用服务器的实例 ID。取值可以由多个实例 ID 组成一个 JSON 数组,最多支持 50 个 ID,ID 之间用半角逗号(,)隔开。

示例值:["2ad1ae67295445f598017499dc****", "2ad1ae67295445f598017123dc****"]参考取值来源:
    ListInstances
    CreateInstances
    DescribeDatabaseInstances

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:20758A-585D-4A41-A9B2-28DA8F4F****
InvokeIdstring

命令执行 ID。

示例值:t-bj02prjhw1n****

返回示例

变更历史

暂无变更历史

相关示例