调用InvokeShellCommand在指定的集群节点内执行交互命令。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
ehpc:InvokeShellCommand | Write |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ClusterId | string | 是 | 集群 ID。 您可以通过调用 ListClusters 获取集群 ID。 | ehpc-hz-FYUr32**** |
Command | string | 是 | 命令内容。长度为 2~2048 个字符。 | echo "hello world" |
WorkingDir | string | 否 | 命令工作目录。默认值为 | /home |
Timeout | integer | 否 | 超时时间,超时将终止命令进程。单位:秒 默认值:60 | 3600 |
Instance | object [] | 否 | 执行命令的节点信息列表。 | |
Id | string | 否 | 第 N 个执行命令的节点实例 ID。 说明
用于限定执行范围,不指定则默认在集群所有节点上执行。
| i-bp1in9hmw3ur52x0**** |
返回参数
示例
正常返回示例
JSON
格式
{
"CommandId": "c-hz01v8vudql****",
"RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
"InstanceIds": {
"InstanceId": [
"[ \"i-uf68t1zu3jkhs8w****\", \"i-uf6abz34m2714bp****\", \"i-uf65bh2113hlqvyx****\", \"i-uf68t1zu3jkhs8wx****\", \"i-uf6b0mtpx166fxxi****\", \"i-uf6faknz4dy1bit7****\" ]"
]
}
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidParams | The specified parameter %s is invalid. | 无效的参数:%s |
400 | NotEnabled | You have not enabled this service | 您的账户还未开通此服务 |
400 | InDebt | Your account has overdue payments. | 您的账户已欠费 |
403 | InvalidClusterStatus | The operation failed due to invalid cluster status. | 集群状态不允许执行本次操作。 |
403 | ConflictOpt | A conflicting operation is running. | 有冲突的操作在执行中,请您稍后再试。 |
404 | ClusterNotFound | The specified cluster does not exist. | 指定的集群不存在,请您检查该参数是否正确。 |
404 | ObjectNotFound | The specified object is not found. | 指定的对象未找到,请您检查该参数是否正确。 |
406 | EcsError | An error occurred while calling the ECS API operation. | ECS API调用出错 |
406 | AgentError | The agent service request failed. | 集群侧命令运行失败 |
406 | AliyunError | An Alibaba Cloud product error occurred. | 阿里云产品错误 |
407 | NotAuthorized | You are not authorized by RAM for this request. | 此请求未获得RAM授权 |
409 | PartFailure | Part of the batch operation failed. | 批量操作部分失败 |
500 | UnknownError | An unknown error occurred. | 未知错误 |
503 | ServiceUnavailable | The request has failed due to a temporary failure of the server | 请求失败,服务暂时不可用 |
访问错误中心查看更多错误码。