调用ListJobs查询指定集群中的作业列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListJobs |
系统规定参数。取值:ListJobs。 |
ClusterId | String | 是 | ehpc-hz-FYUr32**** |
集群ID。 您可以通过调用ListClusters获取集群ID。 |
Owner | String | 否 | user1 |
运行作业的用户。 您可以通过调用ListUsers获取该集群中的用户ID。 |
State | String | 否 | FINISHED |
作业状态。取值范围:
|
Rerunable | String | 否 | false |
是否支持重新运行作业。取值范围:
默认值:false |
PageNumber | Integer | 否 | 1 |
当前页码。 起始值:1 默认值:1 |
PageSize | Integer | 否 | 10 |
分页查询时设置的每页行数。最大值:50 默认值:10 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
PageSize | Integer | 10 |
分页查询时设置的本页条数。 |
RequestId | String | 04F0F334-1335-436C-A1D7-6C044FE7**** |
请求ID。 |
PageNumber | Integer | 1 |
当前页码。 |
TotalCount | Integer | 1 |
列表条目总数。 |
Jobs | Array of JobInfo |
作业信息列表。 |
|
JobInfo | |||
Owner | String | user1 |
执行作业的用户名。 |
Comment | String | jobDescription |
作业描述信息。 |
State | String | FINISHED |
作业状态。可能值:
|
Stderr | String | ./Temp |
错误输出位置。 |
Priority | String | 0 |
处理作业的优先级。取值范围:0~9,取值越大,优先级越高。 |
ShellPath | String | ./Temp |
运行作业路径。 |
Stdout | String | ./Temp |
标准输出位置。 |
ArrayRequest | String | 1-10:2 |
作业队列格式。如果不是队列作业,输出为空。 格式为X-Y:Z, 最小值X是第一个索引,最大值Y是最后一个索引,Z表示步长,例如2-7:2,表示作业队列包含编号为2、4、6的3个子作业。 |
StartTime | String | 2018-07-18T17:46:48 |
作业开始时间。 |
LastModifyTime | String | 2018-07-18T17:46:48 |
作业最后修改时间。 |
NodeList | String | ['compute2', 'compute3'] |
运行作业的计算节点列表。 |
Name | String | job1 |
作业名称。 |
Id | String | 0.manager |
作业ID。 |
SubmitTime | String | 2018-07-18T17:46:47 |
作业提交时间。 |
Resources | Object |
作业运行所需资源。 |
|
Nodes | Integer | 0 |
作业运行的节点数量。 |
Cores | Integer | 2 |
运行作业的CPU个数。 |
示例
请求示例
https://ehpc.cn-hangzhou.aliyuncs.com/?Action=ListJobs
&ClusterId=ehpc-hz-FYUr32****
&<公共请求参数>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<ListJobsResponse>
<TotalCount>1</TotalCount>
<PageSize>10</PageSize>
<RequestId>04F0F334-1335-436C-A1D7-6C044FE7****</RequestId>
<PageNumber>1</PageNumber>
<Jobs>
<JobInfo>
<Comment>jobDescription</Comment>
<Owner>user1</Owner>
<Priority>0</Priority>
<NodeList>['compute2', 'compute3']</NodeList>
<StartTime>2018-07-18T17:46:48</StartTime>
<LastModifyTime>2018-07-18T17:46:48</LastModifyTime>
<SubmitTime>2018-07-18T17:46:47</SubmitTime>
<Name>job1</Name>
<Stderr>./Temp</Stderr>
<State>FINISHED</State>
<ShellPath>./Temp</ShellPath>
<Id>0.manager</Id>
<ArrayRequest>1-10:2</ArrayRequest>
<Stdout>./Temp</Stdout>
<Resources>
<Cores>2</Cores>
<Nodes>0</Nodes>
</Resources>
</JobInfo>
</Jobs>
</ListJobsResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"TotalCount" : 1,
"PageSize" : 10,
"RequestId" : "04F0F334-1335-436C-A1D7-6C044FE7****",
"PageNumber" : 1,
"Jobs" : {
"JobInfo" : {
"Comment" : "jobDescription",
"Owner" : "user1",
"Priority" : 0,
"NodeList" : "['compute2', 'compute3']",
"StartTime" : "2018-07-18T17:46:48",
"LastModifyTime" : "2018-07-18T17:46:48",
"SubmitTime" : "2018-07-18T17:46:47",
"Name" : "job1",
"Stderr" : "./Temp",
"State" : "FINISHED",
"ShellPath" : "./Temp",
"Id" : "0.manager",
"ArrayRequest" : "1-10:2",
"Stdout" : "./Temp",
"Resources" : {
"Cores" : 2,
"Nodes" : 0
}
}
}
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidParams | The specified parameter %s is invalid. | 无效的参数:%s |
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 | ManagerNotFound | The manager nodes do not exist or their status is abnormal. | 管理节点不存在或状态异常。 |
503 | ServiceUnavailable | The request has failed due to a temporary failure of the server | 请求失败,服务暂时不可用 |
406 | AgentError | The agent service request failed. | 代理请求失败 |
406 | AgentError.Job.ListFailure | Failed to list jobs: %s. | 获取作业列表失败:{} |
406 | AliyunError | An Alibaba Cloud product error occurred. | 阿里云产品错误 |
406 | ExecFail | Failed to execute the command: %s. | 命令执行失败: %s |
407 | NotAuthorized | You are not authorized by RAM for this request. | 此请求未获得RAM授权 |
访问错误中心查看更多错误码。