All Products
Search
Document Center

Elastic High Performance Computing:ListJobs

Last Updated:Apr 09, 2024

Queries the list of jobs in a cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:
    • The required resource types are displayed in bold characters.
    • 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.
OperationAccess levelResource typeCondition keyAssociated operation
ehpc:ListJobsREAD
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ClusterIdstringYes

The ID of the E-HPC cluster.

You can call the ListClusters operation to query the cluster ID.

ehpc-hz-FYUr32****
OwnerstringNo

The name of the user that runs the job.

You can call the ListUsers operation to query the users in the cluster.

user1
StatestringNo

The status of the job. Valid values:

  • all
  • finished
  • notfinish
finished
RerunablestringNo

Specifies whether the job can be rerun. Valid values:

  • true
  • false

Default value: false.

false
PageNumberintegerNo

The page number of the page to return.

Pages start from 1.

Default value: 1.

1
PageSizeintegerNo

The number of entries to return per page. Maximum value: 50.

Default value: 10.

10

Response parameters

ParameterTypeDescriptionExample
object
PageSizeinteger

The number of entries returned per page.

10
RequestIdstring

The request ID.

04F0F334-1335-436C-A1D7-6C044FE7****
PageNumberinteger

The page number returned.

1
TotalCountinteger

The total number of returned entries.

1
Jobsobject []

The list of jobs.

Ownerstring

The name of the user that ran the job.

user1
Commentstring

The description of the job.

jobDescription
Statestring

The status of the job. Valid values:

  • FINISHED: The job is completed
  • RUNNING: The job connector is running.
  • QUEUED: The job is pending in a queue.
FINISHED
Stderrstring

The output file path of stderr.

./Temp
Prioritystring

The priority of the job. Valid values: 0 to 9. A large value indicates a higher priority.

0
ShellPathstring

The path that was used to run the job.

./Temp
Stdoutstring

The output file path of stdout.

./Temp
ArrayRequeststring

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
StartTimestring

The time when the job was created.

2018-07-18T17:46:48
LastModifyTimestring

The time when the job was last modified.

2018-07-18T17:46:48
NodeListstring

The list of compute nodes that were used to run the job.

['compute2', 'compute3']
Namestring

The name of the job.

job1
Idstring

The job ID.

0.manager
SubmitTimestring

The time when the job was submitted.

2018-07-18T17:46:47
Resourcesobject

The resources that were used to run the job.

Nodesinteger

The number of nodes that were used to run the job.

0
Coresinteger

The number of CPUs that were used to run the job.

2

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
400InvalidParamsThe specified parameter %s is invalid.The specified parameter %s is invalid.
403InvalidClusterStatusThe operation failed due to invalid cluster status.The cluster status does not support the operation.
403ConflictOptA conflicting operation is running.A conflicting operation is running. Please try again later.
404ClusterNotFoundThe specified cluster does not exist.The specified instance does not exist.
404ManagerNotFoundThe manager nodes do not exist or their status is abnormal.The manager nodes do not exist or their status is abnormal.
406AgentErrorThe agent service request failed.-
406AgentError.Job.ListFailureFailed to list jobs: %s.Failed to obtain the job list: %s
406AliyunErrorAn Alibaba Cloud product error occurred.An Alibaba Cloud product error occurred.
406ExecFailFailed to execute the command: %s.Failed to execute the command: %s.
406AgentResponseTimeoutAgent response timeout: %s-
407NotAuthorizedYou are not authorized by RAM for this request.The request is not authorized by RAM.
500UnknownErrorAn unknown error occurred.An unknown error occurred.
503ServiceUnavailableThe request has failed due to a temporary failure of the serverThe request has failed due to a temporary failure of the server.

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