调用ListCommands查看指定集群内的交互命令列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListCommands | 系统规定参数。取值:ListCommands。 |
ClusterId | String | 是 | ehpc-hz-FYUr32**** | 集群ID。 您可以通过调用ListClusters获取集群ID。 |
CommandId | String | 否 | c-hz01v8vudql**** | 命令ID。 |
PageNumber | Integer | 否 | 1 | 当前页码。 起始值:1。 默认值:1。 |
PageSize | Integer | 否 | 10 | 每页显示的行数。 取值范围:1~50。 默认值:10。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
PageSize | Integer | 10 | 本页条数。 |
RequestId | String | 04F0F334-1335-436C-A1D7-6C044FE7**** | 请求ID。 |
PageNumber | Integer | 1 | 当前页码。 |
TotalCount | Integer | 1 | 列表条目总数。 |
Commands | Array of Command | 命令列表。 |
|
Command | |||
Timeout | String | 60 | 超时时间。单位为秒。 |
CommandId | String | c-hz01v8vudql**** | 命令ID。 |
WorkingDir | String | /home | 命令工作目录。 |
CommandContent | String | echo "hello world" | 命令内容。 |
示例
请求示例
https://ehpc.cn-hangzhou.aliyuncs.com/?Action=ListCommands
&ClusterId=ehpc-hz-FYUr32****
&<公共请求参数>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<ListCommandsResponse>
<PageSize>10</PageSize>
<RequestId>04F0F334-1335-436C-A1D7-6C044FE7****</RequestId>
<PageNumber>1</PageNumber>
<TotalCount>1</TotalCount>
<Commands>
<Timeout>60</Timeout>
<CommandId>c-hz01v8vudql****</CommandId>
<WorkingDir>/home</WorkingDir>
<CommandContent>echo "hello world"</CommandContent>
</Commands>
</ListCommandsResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"PageSize" : 10,
"RequestId" : "04F0F334-1335-436C-A1D7-6C044FE7****",
"PageNumber" : 1,
"TotalCount" : 1,
"Commands" : [ {
"Timeout" : "60",
"CommandId" : "c-hz01v8vudql****",
"WorkingDir" : "/home",
"CommandContent" : "echo \"hello world\""
} ]
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidParams | The specified parameter %s is invalid. | 无效的参数:%s |
400 | NotEnabled | You have not enabled this service | 您的账户还未开通此服务 |
400 | InDebt | Your account has overdue payments. | 您的账户已欠费 |
500 | UnknownError | An unknown error occurred. | 未知错误,请检查相关参数是否合理,检查后稍后重试。 |
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. | 指定的对象未找到,请您检查该参数是否正确。 |
503 | ServiceUnavailable | The request has failed due to a temporary failure of the server | 请求失败,服务暂时不可用 |
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. | 批量操作部分失败 |
访问错误中心查看更多错误码。