Query the list of jobs in a cluster with ListJobs - Elastic High Performance Computing - Alibaba Cloud - Elastic High Performance Computing

Queries the list of jobs in a specified cluster.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ehpc:ListJobs

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The cluster ID. You can call ListClusters to obtain the cluster ID.	ehpc-hz-FYUr32****
Owner	string	No	The user who runs the job. You can call ListUsers to obtain the user IDs in the cluster.	user1
State	string	No	The job status. Valid values: all: all states. finished: completed. notfinish: not completed.	finished
Rerunable	string	No	Specifies whether the job can be rerun. Valid values: true: The job can be rerun. false: The job cannot be rerun. Default value: false.	false
PageNumber	integer	No	The page number. Minimum value: 1. Default value: 1.	1
PageSize	integer	No	The number of entries per page in a paged query. Settings this to a maximum value of 50 controls paging behavior. Default value: 10.	10

Response elements

Element	Type	Description	Example
	object
PageSize	integer	The number of entries on the current page in a paged query. Settings for paging are reflected in this value.	10
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE7****
PageNumber	integer	The page number.	1
TotalCount	integer	The total number of entries returned.	1
Jobs	object
JobInfo	array<object>	The list of job information.
	array<object>
Owner	string	The username of the user who runs the job.	user1
Comment	string	The job description.	jobDescription
State	string	The job status. Valid values: FINISHED: The job is completed. RUNNING: The job is running. QUEUED: The job is queued.	FINISHED
Stderr	string	The path of the error output.	./Temp
Priority	string	The priority of the job. Valid values: 0 to 9. A larger value indicates a higher priority.	0
ShellPath	string	The path of the job script.	./Temp
Stdout	string	The path of the standard output.	./Temp
ArrayRequest	string	The job array format. If the job is not an array job, the output is empty. The format is X-Y:Z, where X is the minimum value (first index), Y is the maximum value (last index), and Z is the step size. For example, 2-7:2 indicates that the job array contains three sub-jobs numbered 2, 4, and 6.	1-10:2
StartTime	string	The time when the job started. The time is in the YYYY-MM-DDTHH:mm:ss format and does not contain time zone information.	2018-07-18T17:46:48
LastModifyTime	string	The time when the job was last modified. The time is in the YYYY-MM-DDTHH:mm:ss format and does not contain time zone information.	2018-07-18T17:46:48
NodeList	string	The list of compute nodes on which the job runs.	['compute2', 'compute3']
Name	string	The job name.	job1
Id	string	The job ID.	0.manager
SubmitTime	string	The time when the job was submitted. The time is in the YYYY-MM-DDTHH:mm:ss format and does not contain time zone information.	2018-07-18T17:46:47
Resources	object	The resources required to run the job.
Nodes	integer	The number of nodes used to run the job.	0
Cores	integer	The number of CPUs used to run the job.	2

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParams	The specified parameter %s is invalid.	The specified parameter %s is invalid.
500	UnknownError	An unknown error occurred.	An unknown error occurred.
403	InvalidClusterStatus	The operation failed due to invalid cluster status.	The cluster status does not support the operation.
403	ConflictOpt	A conflicting operation is running.	A conflicting operation is running. Please try again later.
404	ClusterNotFound	The specified cluster does not exist.	The specified instance does not exist.
404	ManagerNotFound	The manager nodes do not exist or their status is abnormal.	The manager nodes do not exist or their status is abnormal.
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.
406	AgentError	The agent service request failed.	The cluster-side command failed to run. %s
406	AgentError.Job.ListFailure	Failed to list jobs: %s.	Failed to obtain the job list: %s
406	AliyunError	An Alibaba Cloud product error occurred.	Alibaba Cloud product error. %s
406	ExecFail	Failed to execute the command: %s.
406	AgentResponseTimeout	Agent response timeout: %s	The proxy response timed out.
407	NotAuthorized	You are not authorized by RAM for this request.	The request is not authorized by RAM.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.