Runs interactive commands in a cluster node.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action
policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resources
is used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
ehpc:InvokeShellCommand | create | *All Resources * |
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
ClusterId | string | Yes | The cluster ID. You can call the ListClusters operation to query the cluster ID. | ehpc-hz-FYUr32**** |
Command | string | Yes | The content of the command. The content must be 2 to 2,048 characters in length. | echo "hello world" |
WorkingDir | string | No | The working directory of the command. Default value: | /home |
Timeout | integer | No | The timeout period. If a command times out, the command process will be terminated. Unit: seconds. Default value: 60. | 3600 |
Instance | array<object> | No | The information of nodes on which the command is run. | |
object | No | |||
Id | string | No | 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
Examples
Sample success responses
JSON
format
{
"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 code | Error code | Error message | Description |
---|---|---|---|
400 | InvalidParams | The specified parameter %s is invalid. | The specified parameter %s is invalid. |
400 | NotEnabled | You have not enabled this service | You have not enabled this service |
400 | InDebt | Your account has overdue payments. | Your account has overdue payments. |
403 | InvalidClusterStatus | The operation failed due to invalid cluster status. | The cluster status does not support the operation. |
403 | ConflictOpt | A conflicting operation is running. | A conflicting operation is running. Please try again later. |
404 | ClusterNotFound | The specified cluster does not exist. | The specified instance does not exist. |
404 | ObjectNotFound | The specified object is not found. | The specified object does not exist. Please verify the parameter. |
406 | EcsError | An error occurred while calling the ECS API operation. | ECS API call error. %s |
406 | AgentError | The agent service request failed. | The cluster-side command failed to run. %s |
406 | AliyunError | An Alibaba Cloud product error occurred. | Alibaba Cloud product error. %s |
407 | NotAuthorized | You are not authorized by RAM for this request. | The request is not authorized by RAM. |
409 | PartFailure | Part of the batch operation failed. | Part of the batch operation failed. |
500 | UnknownError | An unknown error occurred. | An unknown error occurred. |
503 | ServiceUnavailable | The request has failed due to a temporary failure of the server | The request has failed due to a temporary failure of the server. |
For a list of error codes, visit the Service error codes.