调用ListJobsWithFilters按照相关参数查询指定作业详情。

调试

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

请求参数

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

系统规定参数。取值：ListJobsWithFilters。

ClusterId String 是 ehpc-hz-FYUr32****

集群ID。

您可以通过调用ListClusters获取集群ID。

PageNumber Long 否 1

当前页码。

起始值：1。

默认值：1。
PageSize Long 否 10

分页查询时设置的每页行数。最大值：50。

默认值：10。
Users.N String 否 user1

执行作业的用户名，支持模糊查询。

您可以通过调用ListUsers获取该集群中的用户ID。

Queues.N String 否 workq

执行作业的队列名称。支持模糊查询。
Nodes.N String 否 node1

计算节点名称，支持模糊查询。
JobName String 否 job1

作业名称。支持模糊查询。
JobStatus String 否 finished

作业状态。取值范围：

  • all：所有状态。
  • finished：已完成。
  • notfinish：未完成。

默认值：all。
ExecuteOrder String 否 asc

按照作业执行时间进行排序。取值范围：

  • asc：升序。
  • desc：降序。
SubmitOrder String 否 asc

按照作业提交时间进行排序。取值范围：

  • asc：升序。
  • desc：降序。
PendOrder String 否 desc

按照作业排队时间进行排序。取值范围：

  • asc：升序。
  • desc：降序。
RegionId String 否 cn-hangzhou

地域ID。

您可以调用ListRegions查询可以使用E-HPC的地域列表。

CreateTimeStart String 否 1647427667

作业最早提交时间。格式为Unix时间戳，表示从1970-01-01T00:00:00Z起所经过的秒数。
CreateTimeEnd String 否 1647428667

作业最晚提交时间。格式为Unix时间戳，表示从1970-01-01T00:00:00Z起所经过的秒数。
Async Boolean 否 false

是否异步查询。

返回数据

名称 类型 示例值 描述
TotalCount Integer 1

本次请求条件下的数据总条数。
RequestId String 04F0F334-1335-436C-A1D7-6C044FE7****

请求ID。
PageSize Long 10

分页查询时设置的本页条数。
PageNumber Long 1

当前页码。
Jobs Array of JobInfo

作业信息列表。
Owner String test2@scheduler

执行作业的用户名。
Comment String jobDescription

作业描述信息。
State String FINISHED

作业状态。取值范围：

  • FINISHED：已完成。
  • RUNNING：运行中。
  • QUEUED：列队等待。
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 1647427667

作业开始时间。
LastModifyTime String 1647428667

作业最后修改时间。
NodeList String ['compute2', 'compute3']

运行作业的计算节点列表。
Name String job1

作业名称。
Id String 8.scheduler

作业ID。
SubmitTime String 1647423718

作业提交时间戳。
Resources Object

作业运行所需资源。
Nodes Long 0

作业运行的节点数量。
Cores Long 2

运行作业的CPU个数。
Queue String 2

运行作业的队列数量。
Rerunable Boolean true

作业是否支持重新运行。可能值：

  • true：支持。
  • false：不支持。
VariableList String {"PBS_O_SHELL":"/bin/bash", "PBS_O_HOST":"manager", "PBS_O_SYSTEM":"Linux", "PBS_O_LANG":"en_US.UTF-8", "PBS_O_QUEUE":"workq"}

作业的变量列表。
Success Boolean true

执行命令并获取结果的过程是否成功。取值范围：

  • true：成功。
  • false：失败。

示例

请求示例

http(s)://ehpc.cn-hangzhou.aliyuncs.com/?Action=ListJobsWithFilters
&ClusterId=ehpc-hz-FYUr32****
&PageSize=10
&PageNumber=1
&Users=["user1"]
&Queues=["workq"]
&Nodes=["node1"]
&JobName=job1
&JobStatus=finished
&ExecuteOrder=asc
&SubmitOrder=asc
&PendOrder=desc
&RegionId=cn-hangzhou
&CreateTimeStart=1647427667
&CreateTimeEnd=1647428667
&公共请求参数

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<ListJobsWithFiltersResponse>
    <TotalCount>1</TotalCount>
    <RequestId>04F0F334-1335-436C-A1D7-6C044FE7****</RequestId>
    <PageSize>10</PageSize>
    <PageNumber>1</PageNumber>
    <Jobs>
        <Owner>test2@scheduler</Owner>
        <Comment>jobDescription</Comment>
        <State>FINISHED</State>
        <Stderr>./Temp</Stderr>
        <Priority>0</Priority>
        <ShellPath>./Temp</ShellPath>
        <Stdout>./Temp</Stdout>
        <ArrayRequest>1-10:2</ArrayRequest>
        <StartTime>1647427667</StartTime>
        <LastModifyTime>1647428667</LastModifyTime>
        <NodeList>['compute2', 'compute3']</NodeList>
        <Name>job1</Name>
        <Id>8.scheduler</Id>
        <SubmitTime>1647423718</SubmitTime>
        <Resources>
            <Nodes>0</Nodes>
            <Cores>2</Cores>
        </Resources>
        <Queue>2</Queue>
    </Jobs>
    <Success>true</Success>
</ListJobsWithFiltersResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalCount" : 1,
  "RequestId" : "04F0F334-1335-436C-A1D7-6C044FE7****",
  "PageSize" : 10,
  "PageNumber" : 1,
  "Jobs" : [ {
    "Owner" : "test2@scheduler",
    "Comment" : "jobDescription",
    "State" : "FINISHED",
    "Stderr" : "./Temp",
    "Priority" : "0",
    "ShellPath" : "./Temp",
    "Stdout" : "./Temp",
    "ArrayRequest" : "1-10:2",
    "StartTime" : "1647427667",
    "LastModifyTime" : "1647428667",
    "NodeList" : "['compute2', 'compute3']",
    "Name" : "job1",
    "Id" : "8.scheduler",
    "SubmitTime" : "1647423718",
    "Resources" : {
      "Nodes" : 0,
      "Cores" : 2
    },
    "Queue" : "2"
  } ],
  "Success" : true
}

错误码

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