调用ListJobs查询作业列表_弹性高性能计算(E-HPC)-阿里云帮助中心

调用ListJobs查询指定集群中的作业列表。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
ehpc:ListJobs	Read	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
ClusterId	string	是	集群 ID。您可以通过调用 ListClusters 获取集群 ID。	ehpc-hz-FYUr32****
Owner	string	否	运行作业的用户。您可以通过调用 ListUsers 获取该集群中的用户 ID。	user1
State	string	否	作业状态。取值范围： all：所有状态。 finished：已完成。 notfinish：未完成。	finished
Rerunable	string	否	是否支持重新运行作业。取值范围： true：支持。 false：不支持。默认值：false。	false
PageNumber	integer	否	当前页码。起始值：1。默认值：1。	1
PageSize	integer	否	分页查询时设置的每页行数。最大值：50。默认值：10。	10

返回参数

名称	类型	描述	示例值
	object
PageSize	integer	分页查询时设置的本页条数。	10
RequestId	string	请求 ID。	04F0F334-1335-436C-A1D7-6C044FE7****
PageNumber	integer	当前页码。	1
TotalCount	integer	列表条目总数。	1
Jobs	object []	作业信息列表。
Owner	string	执行作业的用户名。	user1
Comment	string	作业描述信息。	jobDescription
State	string	作业状态。可能值： FINISHED：已完成。 RUNNING：运行中。 QUEUED：列队等待。	FINISHED
Stderr	string	错误输出位置。	./Temp
Priority	string	处理作业的优先级。取值范围：0~9，取值越大，优先级越高。	0
ShellPath	string	运行作业路径。	./Temp
Stdout	string	标准输出位置。	./Temp
ArrayRequest	string	作业队列格式。如果不是队列作业，输出为空。格式为 X-Y:Z，最小值 X 是第一个索引，最大值 Y 是最后一个索引，Z 表示步长，例如 2-7:2，表示作业队列包含编号为 2、4、6 的 3 个子作业。	1-10:2
StartTime	string	作业开始时间。	2018-07-18T17:46:48
LastModifyTime	string	作业最后修改时间。	2018-07-18T17:46:48
NodeList	string	运行作业的计算节点列表。	['compute2', 'compute3']
Name	string	作业名称。	job1
Id	string	作业 ID。	0.manager
SubmitTime	string	作业提交时间。	2018-07-18T17:46:47
Resources	object	作业运行所需资源。
Nodes	integer	作业运行的节点数量。	0
Cores	integer	运行作业的 CPU 个数。	2

示例

正常返回示例

JSON格式

{
  "PageSize": 10,
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE7****",
  "PageNumber": 1,
  "TotalCount": 1,
  "Jobs": {
    "JobInfo": [
      {
        "Owner": "user1",
        "Comment": "jobDescription",
        "State": "FINISHED",
        "Stderr": "./Temp",
        "Priority": "0",
        "ShellPath": "./Temp",
        "Stdout": "./Temp",
        "ArrayRequest": "1-10:2",
        "StartTime": "2018-07-18T17:46:48",
        "LastModifyTime": "2018-07-18T17:46:48",
        "NodeList": "['compute2', 'compute3']",
        "Name": "job1",
        "Id": "0.manager",
        "SubmitTime": "2018-07-18T17:46:47",
        "Resources": {
          "Nodes": 0,
          "Cores": 2
        }
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParams	The specified parameter %s is invalid.	无效的参数：%s
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.	管理节点不存在或状态异常。
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
406	AgentResponseTimeout	Agent response timeout: %s	代理响应超时
407	NotAuthorized	You are not authorized by RAM for this request.	此请求未获得RAM授权
500	UnknownError	An unknown error occurred.	未知错误
503	ServiceUnavailable	The request has failed due to a temporary failure of the server	请求失败，服务暂时不可用

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