GetJob - 查询作业详情_弹性高性能计算(E-HPC)-阿里云帮助中心

获取指定作业的详细信息。

调试

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

授权信息

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

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

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

请求参数

名称	类型	必填	描述	示例值
ClusterId	string	是	集群 ID。	ehpc-hz-FYUr32****
JobId	string	是	作业 ID。通过 ListJobs 接口返回。	1.manager

返回参数

名称	类型	描述	示例值
	object	返回参数集合。
RequestId	string	请求 ID。	04F0**-1335--A1D7-6C044FE7**
JobInfo	object	作业详细信息。
JobId	string	作业 ID。	1.manager
JobName	string	作业名称。	testJob
RunasUser	string	作业所属的用户，即提交作业时使用的用户。该用户为集群侧的用户。	testuser
State	string	作业状态。	Running
JobQueue	string	作业所属队列。	workq
CreateTime	string	作业提交时间。	2024-08-16T10:52:48
LastModifyTime	string	作业状态最后修改时间。	2024-08-16T10:52:48
ErrorLog	string	作业错误日志文件。	/home/xxx/STDIN.e1
StartTime	string	作业启动时间。	2024-08-16T10:52:48
Priority	string	作业优先级。	0
CommandLine	string	作业执行命令。	/home/huangsf/ehpc/job_meta.pbs
OutputLog	string	作业标准输出日志文件。	/home/xxx/STDIN.o1
NodeList	string	作业执行节点列表。	compute000
ArrayRequest	string	作业队列参数。如果不是队列作业，输出为空。格式为 X-Y:Z，最小值 X 是第一个索引，最大值 Y 是最后一个索引，Z 表示步长，例如 2-7:2，表示作业队列包含编号为 2、4、6 的 3 个子作业。	1-5:2
Resources	object	作业提交时申请的资源数量。
Nodes	string	作业使用的节点数。	1
Cores	string	作业在每个节点上使用的 CPU 核数。	2
Memory	string	作业在每个节点上使用的内存大小。	1gb
Gpus	string	作业在每个节点上使用的 GPU 数量。	1
Variables	array<object>	作业的变量列表。
	object	作业的环境变量。
Name	string	环境变量名称。	ProxyIP
Value	string	环境变量值。	10.x.x.x
ExtraInfo	string	其它信息。	{}
ResourcesUsed	object	作业实际使用的资源数量。
Nodes	string	作业使用的总节点数。	2
Cores	string	作业在每个节点上使用的 CPU 核数。	2
Memory	string	作业在每个节点上使用的内存大小。	512mb
ArrayJobId	string	数组父作业 ID，该返回值为非空字符串时，表示该作业是数组作业。	1
ArrayJobSubId	string	数组子作业 ID，ArrayJobId 为非空字符串时有效。	3
Success	string	请求结果，可能值： true：请求成功。 false：请求失败。	true

示例

正常返回示例

JSON格式

{
  "RequestId": "04F0****-1335-****-A1D7-6C044FE7****",
  "JobInfo": {
    "JobId": "1.manager",
    "JobName": "testJob\n",
    "RunasUser": "testuser",
    "State": "Running",
    "JobQueue": "workq",
    "CreateTime": "2024-08-16T10:52:48",
    "LastModifyTime": "2024-08-16T10:52:48",
    "ErrorLog": "/home/xxx/STDIN.e1",
    "StartTime": "2024-08-16T10:52:48",
    "Priority": "0",
    "CommandLine": "/home/huangsf/ehpc/job_meta.pbs",
    "OutputLog": "/home/xxx/STDIN.o1",
    "NodeList": "compute000",
    "ArrayRequest": "1-5:2",
    "Resources": {
      "Nodes": "1",
      "Cores": "2",
      "Memory": "1gb",
      "Gpus": "1"
    },
    "Variables": [
      {
        "Name": "ProxyIP",
        "Value": "10.x.x.x"
      }
    ],
    "ExtraInfo": "{}",
    "ResourcesUsed": {
      "Nodes": "2",
      "Cores": "2",
      "Memory": "512mb"
    },
    "ArrayJobId": "1",
    "ArrayJobSubId": "3"
  },
  "Success": "true"
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParams	The specified parameter %s is invalid.	指定的参数 %s 无效。
403	InvalidClusterStatus	The operation failed due to invalid cluster status.	集群状态不允许执行本次操作。
404	ClusterNotFound	The specified cluster does not exist.	指定的集群不存在，请您检查该参数是否正确。
406	DbError	A database service error occurred.	数据库请求失败
406	EcsError	An error occurred while calling the ECS API operation.	ECS API调用出错
406	AgentError	The agent service request failed: %s	操作未成功：%s
503	ServiceUnavailable	The request has failed due to a temporary failure of the server	请求失败，服务暂时不可用

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