Queries the list of serverless jobs based on filter conditions.
Debugging
Authorization information
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RegionId | string | No | The region ID. You can call the ListRegions operation to query the list of regions where E-HPC is supported. | cn-hangzhou |
| 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. Pages start from page 1. Default value: 1. | 1 |
| PageSize | long | No | The number of entries per page. Maximum value: 100. Default value: 20. | 20 |
| JobIds | array | No | The list of serverless job IDs or subtask IDs (array jobs). | |
| string | No | The ID of the serverless job or subtask (array job). | 5,10_1 | |
| JobNames | array | No | The names of the serverless jobs. | |
| string | No | The name of the serverless job. | testjob | |
| State | string | No | The status of the serverless job. Valid values:
Default value: All. | Running |
| StartOrder | string | No | Specifies whether to sort the serverless jobs by the job start time. Valid values:
| Asc |
| SubmitOrder | string | No | Specifies whether to sort the serverless jobs by the job submission time. Valid values:
| asc |
| SubmitTimeStart | string | No | The earliest time at which the job is submitted. Note
You can use this parameter to query the job list based on the job submission time.
| 1647427667 |
| SubmitTimeEnd | string | No | The latest time at which the job is submitted. Note
You can use this parameter to query the job list based on the job submission time.
| 1659521430 |
Response parameters
Examples
Sample success responses
JSONformat
{
"TotalCount": 1,
"RequestId": "04F0F334-1335-436C-A1D7-6C044FE7****",
"PageSize": 20,
"PageNumber": 1,
"Jobs": [
{
"JobId": "5",
"JobName": "testjob",
"State": "Running",
"Priority": "9",
"Queue": "comp",
"User": "testuser",
"SubmitTime": "1647423718",
"StartTime": "1647427667",
"EndTime": "1682128871",
"IsArrayJob": true
}
]
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | InvalidParams | The specified parameter %s is invalid. | The specified parameter %s is invalid. |
| 400 | NotEnabled | You have not enabled this service | You have not enabled this service |
| 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 | DbError | A database service error occurred. | Database request failed. |
| 406 | EcsError | An error occurred while calling the ECS API operation. | An error occurred while calling the ECS API operation. |
| 406 | RedisError | A Redis service error occurred. | Redis request failed. |
| 406 | AliyunError | An Alibaba Cloud product error occurred. | An Alibaba Cloud product error occurred. |
| 406 | AgentError | The agent service request failed: %s | The agent request failed. |
| 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.
Change history
| Change time | Summary of changes | Operation | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 2023-07-21 | The Error code has changed | see changesets | ||||||||||||||||||||||
| ||||||||||||||||||||||||
| 2023-07-17 | The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed | see changesets | ||||||||||||||||||||||
|