文档

InvokeCommand - 执行命令

更新时间:

为一台或多台轻量应用服务器执行一条命令助手命令。

接口说明

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

调试

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

授权信息

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

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

请求参数

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

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

cn-hangzhou
CommandIdstring

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

c-sh02yh0932w****
Parametersobject

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

  • 自定义参数的个数范围为 0~10。Map 的键不允许为空字符串,最多支持 64 个字符。

  • Map 的值允许为空字符串。自定义参数与原始命令内容在 Base64 编码后,综合长度不能超过 18KB。

  • 设置的自定义参数名集合必须为创建命令时定义的参数集的子集。

  • 对于未传入的参数,您可以使用空字符串代替。您可以取消设置该参数从而禁用自定义参数。

{"delayed_insert_timeout":"600","max_length_for_sort_data":"2048"}
Usernamestring

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

  • Linux 系统的轻量应用服务器,默认以 root 用户执行命令。

  • Windows 系统的轻量应用服务器,默认以 System 用户执行命令。

您可以修改 Linux 系统执行用户,Windows 系统执行用户不支持修改。

test
InstanceIdsstring

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

["2ad1ae67295445f598017499dc****", "2ad1ae67295445f598017123dc****"]

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

20758A-585D-4A41-A9B2-28DA8F4F****
InvokeIdstring

命令执行 ID。

t-bj02prjhw1n****

示例

正常返回示例

JSON格式

{
  "RequestId": "20758A-585D-4A41-A9B2-28DA8F4F****",
  "InvokeId": "t-bj02prjhw1n****"
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)