All Products
Search
Document Center

Elastic High Performance Computing:InvokeShellCommand

Last Updated:Mar 03, 2024

Runs interactive commands in a cluster node.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
ClusterIdstringYes

The cluster ID.

You can call the ListClusters operation to query the cluster ID.

ehpc-hz-FYUr32****
CommandstringYes

The content of the command. The content must be 2 to 2,048 characters in length.

echo "hello world"
WorkingDirstringNo

The working directory of the command. Default value: /root.

/home
TimeoutintegerNo

The timeout period. If a command times out, the command process will be terminated. Unit: seconds.

Default value: 60.

3600
Instanceobject []No

The information of nodes on which the command is run.

IdstringNo

The ID of the Nth node instance on which the command is run.

Note This parameter specifies the node on which the command is run. If it is not specified, the command will be run on all nodes of the cluster.
i-bp1in9hmw3ur52x0****

Response parameters

ParameterTypeDescriptionExample
object
CommandIdstring

The ID of the command. It is used to query the execution status of the command.

c-hz01v8vudql****
RequestIdstring

The ID of the request.

04F0F334-1335-436C-A1D7-6C044FE73368
InstanceIdsarray

The list of IDs of the instances on which you want to run the command.

string

The list of IDs of the instances on which you want to run the command.

[ "i-uf68t1zu3jkhs8w****", "i-uf6abz34m2714bp****", "i-uf65bh2113hlqvyx****", "i-uf68t1zu3jkhs8wx****", "i-uf6b0mtpx166fxxi****", "i-uf6faknz4dy1bit7****" ]

Examples

Sample success responses

JSONformat

{
  "CommandId": "c-hz01v8vudql****",
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "InstanceIds": {
    "InstanceId": [
      "[ \"i-uf68t1zu3jkhs8w****\", \"i-uf6abz34m2714bp****\", \"i-uf65bh2113hlqvyx****\", \"i-uf68t1zu3jkhs8wx****\", \"i-uf6b0mtpx166fxxi****\", \"i-uf6faknz4dy1bit7****\" ]"
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidParamsThe specified parameter %s is invalid.The specified parameter %s is invalid.
400NotEnabledYou have not enabled this serviceYou have not enabled this service
400InDebtYour account has overdue payments.Your account has overdue payments.
403InvalidClusterStatusThe operation failed due to invalid cluster status.The cluster status does not support the operation.
403ConflictOptA conflicting operation is running.A conflicting operation is running. Please try again later.
404ClusterNotFoundThe specified cluster does not exist.The specified instance does not exist.
404ObjectNotFoundThe specified object is not found.The specified object does not exist. Please verify the parameter.
406EcsErrorAn error occurred while calling the ECS API operation.An error occurred while calling the ECS API operation.
406AgentErrorThe agent service request failed.-
406AliyunErrorAn Alibaba Cloud product error occurred.An Alibaba Cloud product error occurred.
407NotAuthorizedYou are not authorized by RAM for this request.The request is not authorized by RAM.
409PartFailurePart of the batch operation failed.Part of the batch operation failed.
500UnknownErrorAn unknown error occurred.An unknown error occurred.
503ServiceUnavailableThe request has failed due to a temporary failure of the serverThe request has failed due to a temporary failure of the server.

For a list of error codes, visit the Service error codes.