Queries the list of jobs in a cluster.
Debugging
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.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
ehpc:ListJobs | READ |
|
| 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**** |
Owner | string | No | The name of the user that runs the job. You can call the ListUsers operation to query the users in the cluster. | user1 |
State | string | No | The status of the job. Valid values:
| finished |
Rerunable | string | No | Specifies whether the job can be rerun. Valid values:
Default value: false. | false |
PageNumber | integer | No | The page number of the page to return. Pages start from 1. Default value: 1. | 1 |
PageSize | integer | No | The number of entries to return per page. Maximum value: 50. Default value: 10. | 10 |
Response parameters
Examples
Sample success responses
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. |
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. |
406 | AgentError | The agent service request failed. | - |
406 | AgentError.Job.ListFailure | Failed to list jobs: %s. | Failed to obtain the job list: %s |
406 | AliyunError | An Alibaba Cloud product error occurred. | An Alibaba Cloud product error occurred. |
406 | ExecFail | Failed to execute the command: %s. | Failed to execute the command: %s. |
406 | AgentResponseTimeout | Agent response timeout: %s | - |
407 | NotAuthorized | You are not authorized by RAM for this request. | The request is not authorized by RAM. |
500 | UnknownError | An unknown error occurred. | An unknown error occurred. |
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.