一台或多台灵骏机器中执行一段Shell的脚本。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
eflo:RunCommand | update | Node acs:eflo:{#regionId}:{#accountId}:node/{#NodeId} Command acs:ecs:{#regionId}:{#accountId}:command/{#CommandId} |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Name | string | 否 | 命令名称。 | testName |
Description | string | 否 | 命令描述。 | testDescription |
CommandContent | string | 否 | 命令内容。您需要注意:
| ZWNobyAxMjM= |
Timeout | integer | 否 | 执行命令的超时时间,单位:秒。当因为进程原因、缺失模块、缺失云助手 Agent 等原因无法运行命令时,会出现超时现象。超时后,会强制终止命令进程。默认值:60。 | 3600 |
WorkingDir | string | 否 | 您可自定义命令的执行路径。默认路径如下: Linux 实例:执行路径默认在管理员 root 用户的/home 目录下。 | /home/user |
EnableParameter | boolean | 否 | 命令中是否包含自定义参数。 默认值:false。 | false |
ContentEncoding | string | 否 | 脚本内容的编码方式。取值范围:
默认值:PlainText。乱填或错填时,该取值会当作 PlainText 处理。 | Base64 |
Username | string | 否 | 在实例中执行命令的用户名称。长度不得超过 255 个字符。 Linux 系统的实例,默认以 root 用户执行命令。 | root |
NodeIdList | array | 否 | 节点列表。 | |
string | 否 | 节点 ID。 | "i-bp185dy2o3o6neg****" | |
RepeatMode | string | 否 | 设置命令执行的方式。取值范围:
默认值:
| Once |
ClientToken | string | 否 | 保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符,且不能超过 64 个字符。更多信息,请参见如何保证幂等性。 | 123e4567-e89b-12d3-a456-426655440000 |
Frequency | string | 否 | 定时执行命令的执行时间。目前支持三种定时执行方式:固定时间间隔执行(基于 Rate 表达式)、仅在指定时间执行一次、基于时钟定时执行(基于 Cron 表达式)。
| 0 */20 * * * ? |
Parameters | object | 否 | 命令中包含自定义参数时,执行命令时传入的自定义参数的键值对。例如,命令内容为 自定义参数的个数范围为 0~10,且您需要注意:
默认值为空,表示取消设置该参数从而禁用自定义参数。 | {"name":"Jack", "accessKey":"LTAI***********"} |
CommandId | string | 否 | 命令 ID | c-e996287206324975b5fbe1d*** |
TerminationMode | string | 否 | 停止任务(手动停止或执行超时打断)时的模式。可能值: Process:停止当前脚本进程。 ProcessTree:停止当前进程树(脚本进程以及它创建的所有子进程的集合) | ProcessTree |
Launcher | string | 否 | 脚本执行的引导程序。长度不能超过 1 KB。 | python3 -u {{ACS::ScriptFileName|Ext(".py")}} |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "2FE2B22C-CF9D-59DE-BF63-DC9B9B33A9D1",
"InvokeId": "t-7d2a745b412b4601b2d47f6a768d*"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2025-01-02 | OpenAPI 入参发生变更 | 查看变更详情 |