Call ListJobsWithFilters to query job details - Elastic High Performance Computing - Alibaba Cloud - Elastic High Performance Computing

Queries the details of a specified job based on the specified parameter query conditions.

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:ListJobsWithFilters

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The cluster ID. You can call ListClusters to query the cluster ID.	ehpc-hz-FYUr32****
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. This is the number of entries per page configured in Settings for paging. Maximum value: 50. Default value: 10.	10
Users	array	No	The list of users who run the job.
	string	No	The username of the user who runs the job. Fuzzy match is supported. You can call ListUsers to query the user IDs in the cluster.	user1
Queues	array	No	The list of queues in which the job runs.
	string	No	The name of the queue in which the job runs. Fuzzy match is supported.	workq
Nodes	array	No	The list of compute nodes on which the job runs.
	string	No	The name of the compute node. Fuzzy match is supported.	node1
JobName	string	No	The job name. Fuzzy match is supported.	job1
JobStatus	string	No	The job status. Valid values: all: All statuses. finished: Completed. notfinish: Not completed. Default value: all.	finished
ExecuteOrder	string	No	The order in which jobs are sorted by execution time. Valid values: asc: ascending order. desc: descending order.	asc
SubmitOrder	string	No	The order in which jobs are sorted by submission time. Valid values: asc: ascending order. desc: descending order.	asc
PendOrder	string	No	The order in which jobs are sorted by queuing time. Valid values: asc: ascending order. desc: descending order.	desc
RegionId	string	No	The region ID. You can call ListRegions to query the regions where Elastic High Performance Computing (E-HPC) is available.	cn-hangzhou
CreateTimeStart	string	No	The earliest job submission time. The value is a UNIX timestamp, which represents the number of seconds elapsed since 1970-01-01T00:00:00Z.	1647427667
CreateTimeEnd	string	No	The latest job submission time. The value is a UNIX timestamp, which represents the number of seconds elapsed since 1970-01-01T00:00:00Z.	1647428667
Async	boolean	No	Specifies whether to perform an asynchronous query.	false

Response elements

Element	Type	Description	Example
	object	Schema of Response
TotalCount	integer	The total number of entries returned under the current query conditions.	1
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE7****
PageSize	integer	The number of entries per page in a paged query. This is the number of entries per page configured in Settings for paging.	10
PageNumber	integer	The page number.	1
Jobs	array<object>	The list of jobs.
	array<object>
Owner	string	The username of the user who runs the job.	test2@scheduler
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 error output path.	./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 standard output path.	./Temp
ArrayRequest	string	The job array format. If the job is not an array job, the value is empty. The format is X-Y:Z, where X is the minimum value (the first index), Y is the maximum value (the 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 running. The value is a UNIX timestamp, in seconds.	1647427667
LastModifyTime	string	The time when the job was last modified. The value is a UNIX timestamp, in seconds.	1647428667
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.	8.scheduler
SubmitTime	string	The timestamp when the job was submitted.	1647423718
Resources	object	The resources required to run the job.
Nodes	integer	The number of nodes on which the job runs.	0
Cores	integer	The number of CPUs used to run the job.	2
Queue	string	The number of queues in which the job runs.	2
Rerunable	boolean	Indicates whether the job can be rerun. Valid values: true: The job can be rerun. false: The job cannot be rerun.	true
VariableList	string	The list of variables for the job.	{"PBS_O_SHELL":"/bin/bash", "PBS_O_HOST":"manager", "PBS_O_SYSTEM":"Linux", "PBS_O_LANG":"en_US.UTF-8", "PBS_O_QUEUE":"workq"}
Success	boolean	Indicates whether the command was executed and the result was obtained. Valid values: true: The command was executed and the result was obtained. false: The command failed to be executed or the result failed to be obtained.	true

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message
400	InvalidParams	%s
500	UnknownError	An unknown error occurred.
503	ServiceUnavailable	The request has failed due to a temporary failure of the server
406	AgentError	The agent service request failed.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.