文档

ListJobsWithFilters - 查询作业详情

更新时间:

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ehpc:ListJobsWithFiltersRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
ClusterIdstring

集群 ID。

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

ehpc-hz-FYUr32****
PageNumberlong

当前页码。

起始值:1。

默认值:1。

1
PageSizelong

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

默认值:10。

10
Usersarray

执行作业的用户列表信息。

string

执行作业的用户名,支持模糊查询。 您可以通过调用 ListUsers 获取该集群中的用户 ID。

user1
Queuesarray

执行作业的队列列表信息。

string

执行作业的队列名称。支持模糊查询。

workq
Nodesarray

执行作业的计算节点列表信息。

string

计算节点名称,支持模糊查询。

node1
JobNamestring

作业名称。支持模糊查询。

job1
JobStatusstring

作业状态。取值范围:

  • all:所有状态。

  • finished:已完成。

  • notfinish:未完成。

默认值:all。

finished
ExecuteOrderstring

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

  • asc:升序。

  • desc:降序。

asc
SubmitOrderstring

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

  • asc:升序。

  • desc:降序。

asc
PendOrderstring

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

  • asc:升序。

  • desc:降序。

desc
RegionIdstring

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

cn-hangzhou
CreateTimeStartstring

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

1647427667
CreateTimeEndstring

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

1647428667
Asyncboolean

是否异步查询。

false

返回参数

名称类型描述示例值
object

Schema of Response

TotalCountinteger

本次请求条件下的数据总条数。

1
RequestIdstring

请求 ID。

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

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

10
PageNumberlong

当前页码。

1
Jobsobject []

作业信息列表。

Ownerstring

执行作业的用户名。

test2@scheduler
Commentstring

作业描述信息。

jobDescription
Statestring

作业状态。取值范围:

  • FINISHED:已完成。

  • RUNNING:运行中。

  • QUEUED:列队等待。

FINISHED
Stderrstring

错误输出位置。

./Temp
Prioritystring

处理作业的优先级。取值范围:0~9,取值越大,优先级越高。

0
ShellPathstring

运行作业路径。

./Temp
Stdoutstring

标准输出位置。

./Temp
ArrayRequeststring

作业队列格式。如果不是队列作业,输出为空。

格式为 X-Y:Z, 最小值 X 是第一个索引,最大值 Y 是最后一个索引,Z 表示步长,例如 2-7:2,表示作业队列包含编号为 2、4、6 的 3 个子作业。

1-10:2
StartTimestring

作业开始时间。

1647427667
LastModifyTimestring

作业最后修改时间。

1647428667
NodeListstring

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

['compute2', 'compute3']
Namestring

作业名称。

job1
Idstring

作业 ID。

8.scheduler
SubmitTimestring

作业提交时间戳。

1647423718
Resourcesobject

作业运行所需资源。

Nodeslong

作业运行的节点数量。

0
Coreslong

运行作业的 CPU 个数。

2
Queuestring

运行作业的队列数量。

2
Rerunableboolean

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

  • true:支持。

  • false:不支持。

true
VariableListstring

作业的变量列表。

{"PBS_O_SHELL":"/bin/bash", "PBS_O_HOST":"manager", "PBS_O_SYSTEM":"Linux", "PBS_O_LANG":"en_US.UTF-8", "PBS_O_QUEUE":"workq"}
Successboolean

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

  • true:成功。

  • false:失败。

true

示例

正常返回示例

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",
      "Rerunable": true,
      "VariableList": "{\"PBS_O_SHELL\":\"/bin/bash\", \t\"PBS_O_HOST\":\"manager\", \t\"PBS_O_SYSTEM\":\"Linux\", \t\"PBS_O_LANG\":\"en_US.UTF-8\", \t\"PBS_O_QUEUE\":\"workq\"}"
    }
  ],
  "Success": true
}

错误码

HTTP status code错误码错误信息
400InvalidParams%s
406AgentErrorThe agent service request failed.
500UnknownErrorAn unknown error occurred.
503ServiceUnavailable The request has failed due to a temporary failure of the server

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

  • 本页导读 (1)
文档反馈