ListJobsWithFilters - Elastic High Performance Computing

Queries the details of a specified 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:ListJobsWithFilters		All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The ID of the E-HPC cluster. You can call the ListClusters operation to query the cluster ID.	ehpc-hz-FYUr32****
PageNumber	long	No	The page number to return. Pages start from 1. Default value: 1.	1
PageSize	long	No	The number of entries per page. Maximum value: 50. Default value: 10.	10
Users	array	No	The users that run the job.
	string	No	The name of the user that runs the job. Fuzzy match is supported. You can call the ListUsers operation to query the users in the cluster.	user1
Queues	array	No	The information about the queues in which the job is run.
	string	No	The name of the queue in which the job is run. Fuzzy search is supported.	workq
Nodes	array	No	The information about the computing nodes that are used to run the job.
	string	No	The name of the compute node. Fuzzy match is supported.	node1
JobName	string	No	The name of the job. Fuzzy search is supported.	job1
JobStatus	string	No	The status of the job. Valid values: all finished notfinish Default value: all.	finished
ExecuteOrder	string	No	The order in which jobs are sorted based on the execution time. Valid values: asc: ascending order desc: descending order	asc
SubmitOrder	string	No	The order in which jobs are sorted based on the time when they are submitted. Valid values: asc: ascending order desc: descending order	asc
PendOrder	string	No	The order in which jobs are sorted based on the time when they queue. Valid values: asc: ascending order desc: descending order	desc
RegionId	string	No	The ID of the region. You can call the ListRegions operation to query the list of regions where E-HPC is supported.	cn-hangzhou
CreateTimeStart	string	No	The earliest time when a job is submitted. The value is a UNIX timestamp, which represents the number of seconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.	1647427667
CreateTimeEnd	string	No	The latest time when a job is submitted. The value is a UNIX timestamp, which represents the number of seconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.	1647428667
Async	boolean	No	Specifies whether to enable asynchronous query.	false

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
TotalCount	integer	The total number of entries returned.	1
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE7****
PageSize	long	The number of entries returned per page.	10
PageNumber	long	The page number returned.	1
Jobs	array<object>	The list of jobs.
JobInfo	object
Owner	string	The name of the user that ran the job.	test2@scheduler
Comment	string	The description of the job.	jobDescription
State	string	The status of the job. Valid value: FINISHED: The job is completed. RUNNING: The job is running. QUEUED: The job is pending in a queue.	FINISHED
Stderr	string	The output file path of stderr.	./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 that was used to run the job.	./Temp
Stdout	string	The output file path of stdout.	./Temp
ArrayRequest	string	The job array. If the job is not in a queue, the output is empty. Format: X-Y:Z. X is the minimum index value. Y is the maximum index value. Z is the step size. For example, 2-7:2 indicates that three jobs need to be run and their index values are 2, 4, and 6.	1-10:2
StartTime	string	The time when the job was created.	1647427667
LastModifyTime	string	The time when the job was last modified.	1647428667
NodeList	string	The list of compute nodes that were used to run the job.	['compute2', 'compute3']
Name	string	The name of the job.	job1
Id	string	The job ID.	8.scheduler
SubmitTime	string	The time when the job was submitted.	1647423718
Resources	object	The resources that were used to run the job.
Nodes	long	The number of nodes that were used to run the job.	0
Cores	long	The number of CPUs that were used to run the job.	2
Queue	string	The number of queues that ran the job.	2
Rerunable	boolean	Indicates whether the job can be run again. Valid values: true: yes false: no	true
VariableList	string	The list of variables of 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 request was successful. Valid values: true: The request was successful. false: The request failed.	true

Examples

Sample success responses

JSONformat

{
  "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",
        "PBS_O_HOST": "manager",
        "PBS_O_SYSTEM": "Linux",
        "PBS_O_LANG": "en_US.UTF-8",
        "PBS_O_QUEUE": "workq"
      }
    }
  ],
  "Success": true
}

Error codes

HTTP status code	Error code	Error message
400	InvalidParams	%s
406	AgentError	The agent service request failed.
500	UnknownError	An unknown error occurred.
503	ServiceUnavailable	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