调用ListJobs查询作业列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String ListJobs

操作接口名,系统规定参数,取值:ListJobs

ClusterId String ehpc-hz-123456

集群ID。

Owner String user1

作业owner。

State String finished

作业状态,取值: finished | notfinish

Rerunable String false

作业是否支持rerun。

PageNumber Integer 1

当前页码。

PageSize Integer 1

本页条数,取值1-50。

返回数据

名称 类型 示例值 描述
Jobs Array

作业信息数组。

JobInfo
ArrayRequest String 1-10:2

队列作业的队列输入,例如 1-10:2, 如果不是作队列,可以为空。

Comment String jobDescription

作业当前描述。

Id String 2

作业ID。

LastModifyTime String 2018-07-18T17:46:48

作业最后修改时间。

Name String job1

作业名称。

NodeList String ['compute2', 'compute3']

节点列表。

Owner String root

作业owner。

Priority String 0

作业优先级。

Resources Struct

作业运行所需资源。

Cores Integer 2

作业运行的cpu核数。

Nodes Integer 0

作业运行的节点数量。

ShellPath String ./Temp

运行程序路径。

StartTime String 2018-07-18T17:46:48

作业开始时间。

State String COMPLETED

作业状态。

Stderr String ./Temp

错误输出位置。

Stdout String ./Temp

标准输出位置。

SubmitTime String 2018-07-18T17:46:47

作业提交时间。

PageNumber Integer 1

当前页码。

PageSize Integer 1

本页条数。

RequestId String 04F0F334-1335-436C-A1D7-6C044FE73368

请求ID。

TotalCount Integer 1

列表条目总数。

示例

请求示例

http(s)://[Endpoint]/?Action=ListJobs
&ClusterId=ehpc-hz-123456
&<公共请求参数>

正常返回示例

XML 格式

<ListJobsResponse>
      <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>
      <TotalCount>1</TotalCount>
      <PageNumber>1</PageNumber>
      <PageSize>1</PageSize>
      <Jobs>
            <JobInfo>
                  <Owner>root</Owner>
                  <SubmitTime>2018-07-18T17:46:47</SubmitTime>
                  <Stderr></Stderr>
                  <Comment></Comment>
                  <ArrayRequest></ArrayRequest>
                  <Priority>4294901759</Priority>
                  <Name>sleepjob.sh</Name>
                  <State>COMPLETED</State>
                  <LastModifyTime>2018-07-18T17:46:58</LastModifyTime>
                  <Stdout></Stdout>
                  <Id>2</Id>
                  <StartTime>2018-07-18T17:46:48</StartTime>
                  <NodeList>['compute1', 'compute3']</NodeList>
                  <Resources>
                        <Nodes>2</Nodes>
                        <Cores>0</Cores>
                  </Resources>
            </JobInfo>
      </Jobs>
</ListJobsResponse>

JSON 格式

{
    "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
    "TotalCount": 1,
    "PageNumber": 1,
    "PageSize": 1,
    "Jobs": {
        "JobInfo": [
            {
                "Owner": "root",
                "SubmitTime": "2018-07-18T17:46:47",
                "Stderr": "",
                "Comment": "",
                "ArrayRequest": "",
                "Priority": "4294901759",
                "Name": "sleepjob.sh",
                "State": "COMPLETED",
                "LastModifyTime": "2018-07-18T17:46:58",
                "Stdout":"",
                "Id": "2",
                "StartTime": "2018-07-18T17:46:48",
                "NodeList":"['compute1', 'compute3']",
                "Resources": {
                    "Nodes": 2,
                    "Cores": 0
                }
            }
        ]
    }
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidParams Invalid param: %s 无效的参数: {}
406 AgentError.Job.ListFailure Failed to list jobs: %s 获取作业列表失败: {}

访问错误中心查看更多错误码。