GetJob - Elastic High Performance Computing - Alibaba Cloud Documentation Center

Obtains the details of a job.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
ehpc:GetJob	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The cluster ID.	ehpc-hz-FYUr32****
JobId	string	Yes	The job ID. You can call the ListJobs operation to query the job ID.	1.manager

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	04F0**-1335--A1D7-6C044FE7**
JobInfo	object	The job details.
JobId	string	The job ID.	1.manager
JobName	string	The job name.	testJob
RunasUser	string	The user to which the job belongs or that is used to submit the job. This user is a cluster-side user.	testuser
State	string	The job state.	Running
JobQueue	string	The queue to which the job belongs.	workq
CreateTime	string	The time when the job was submitted.	2024-08-16T10:52:48
LastModifyTime	string	The time when the job was last modified.	2024-08-16T10:52:48
ErrorLog	string	The error log file of the job.	/home/xxx/STDIN.e1
StartTime	string	The time when the job was started.	2024-08-16T10:52:48
Priority	string	The priority of the job.	0
CommandLine	string	The command that is used to run the job.	/home/huangsf/ehpc/job_meta.pbs
OutputLog	string	The standard output log file of the job.	/home/xxx/STDIN.o1
NodeList	string	The compute nodes that are used to run the job.	compute000
ArrayRequest	string	The job queue. If the job is not in a queue, the output is empty. The format is X-Y:Z. X indicates the first index, Y indicates the final index, and Z indicates the step size. For example, 2-7:2 indicates three sub-jobs numbered 2, 4, and 6.	1-5:2
Resources	object	The resources that were requested when the job was submitted.
Nodes	string	The number of nodes that are used to run the job.	1
Cores	string	The number of vCPUs used by the job on each node.	2
Memory	string	The memory size used by the job on each node.	1gb
Gpus	string	The number of GPUs used by the job on each node.	1
Variables	array<object>	The variables of the job.
Variables	object	The environment variables.
Name	string	The name of the environment variable.	ProxyIP
Value	string	The value of the environment variable.	10.x.x.x
ExtraInfo	string	Additional information.	{}
ResourcesUsed	object	The resources that are actually used by the job.
Nodes	string	The number of nodes that are used to run the job.	2
Cores	string	The number of vCPUs used by the job on each node.	2
Memory	string	The memory size used by the job on each node.	512mb
ArrayJobId	string	The parent job ID. If the return value is a non-empty string, the job is an array job.	1
ArrayJobSubId	string	The sub-job ID. This parameter is valid when the ArrayJobId parameter is a non-empty string.	3
Success	string	The request result. Valid values: true false	true

Examples

Sample success responses

JSONformat

{
  "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
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParams	The specified parameter %s is invalid.	The specified parameter %s is invalid.
403	InvalidClusterStatus	The operation failed due to invalid cluster status.	The cluster status does not support the operation.
404	ClusterNotFound	The specified cluster does not exist.	The specified instance does not exist.
406	DbError	A database service error occurred.	Database request failed.
406	EcsError	An error occurred while calling the ECS API operation.	ECS API call error. %s
406	AgentError	The agent service request failed: %s	Operation unsuccessful: %s
503	ServiceUnavailable	The request has failed due to a temporary failure of the server	The request has failed due to a temporary failure of the server.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history