All Products
Search
Document Center

Elastic High Performance Computing:ListCommands

Last Updated:Apr 09, 2024

Queries the interactive commands in a specified cluster.

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****
CommandIdstringNo

The ID of the command.

c-hz01v8vudql****
PageNumberintegerNo

The page number of the page to return.

Page number starts from page 1.

Default value: 1.

1
PageSizeintegerNo

The number of entries to return on each page.
Valid values: 1 to 50.
Default value: 10.

10

Response parameters

ParameterTypeDescriptionExample
object
PageSizeinteger

The number of entries returned per page.

10
RequestIdstring

The ID of the request.

04F0F334-1335-436C-A1D7-6C044FE7****
PageNumberinteger

The page number of the returned page.

1
TotalCountinteger

The total number of returned entries.

1
Commandsobject []

The list of commands.

Timeoutstring

The timeout period. Unit: seconds.

60
CommandIdstring

The ID of the command.

c-hz01v8vudql****
WorkingDirstring

The working directory of the command.

/home
CommandContentstring

The content of the command.

echo "hello world"

Examples

Sample success responses

JSONformat

{
  "PageSize": 10,
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE7****",
  "PageNumber": 1,
  "TotalCount": 1,
  "Commands": {
    "Command": [
      {
        "Timeout": "60",
        "CommandId": "c-hz01v8vudql****",
        "WorkingDir": "/home",
        "CommandContent": "echo \"hello world\""
      }
    ]
  }
}

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.