Views a list of jobs.
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 Resourcesis 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 |
|---|---|---|---|---|
| odps:ListJobInfos | list | *All Resources * |
| none |
Request syntax
POST /api/v1/jobs HTTP/1.1
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| tenantId | string | No | The tenant ID. | 478403690625249 |
| region | string | No | The region ID. | cn-shanghai |
| orderColumn | string | No | The column based on which you want to sort query results. | cuUsage |
| ascOrder | boolean | No | Specifies whether to sort query results in ascending or descending order. | true |
| pageNumber | long | No | The page number. | 1 |
| pageSize | long | No | The number of entries per page. | 10 |
| body | string | No | The request body. | { "from":1672112000, "to":1672112130, "statusList":[], "quotaNickname":"quota_nickname", "projectList":[], "typeList":[], "jobOwnerList":[], "signatureList":[], "extNodeIdList":[], "instanceIdList":[], "priorityList":[], "settings":{ "key":"value" } } |
Response parameters
Examples
Sample success responses
JSONformat
{
"requestId": "0bc13a9516807484336515320e38f5",
"httpCode": 200,
"data": {
"totalCount": 64,
"pageNumber": 2,
"pageSize": 10,
"jobInfoList": [
{
"tenantId": "213065738244354",
"region": "cn-shanghai",
"cluster": "AY20A",
"instanceId": "20230410050036549gfmsdwf60gg",
"jobOwner": "ALIYUN$xxx@test.aliyunid.com",
"project": "openrec_new",
"jobType": "SQL",
"priority": 1,
"status": "running",
"quotaNickname": "my_quota",
"quotaType": "subscription",
"cuUsage": 10,
"memoryUsage": 40,
"cuSnapshot": 0.48,
"memorySnapshot": 0.42,
"statusSnapshot": "running",
"submittedAtTime": 1672112013,
"waitingTime": 100,
"runningAtTime": 1672112113,
"runningTime": 800,
"endAtTime": 0,
"totalTime": 900,
"signature": "i094KijGrN3kOXZ74kbexB77XQY=",
"extPlantFrom": "platform_3",
"extNodeId": "node_4",
"extNodeOnDuty": "duty_2",
"tags": "[]",
"sceneResults": [
{
"sceneTag": "SubscriptionLackResource",
"scene": "LackResource",
"type": "warning",
"summary": "Insufficient computing resources available for the job. Click to view details.",
"description": "This job uses annual and monthly computing resources. It may be that the job is waiting for resources due to the large amount of overall job running data, many resources requested, and low job priority. Please go to Resource Consumption to view the specific situation. You can also go to Cost Optimization to see if you need to adjust resource configuration.",
"params": {
"key": "\"jobinsight_data_skew_node\": \"Worker M1#10000_0\""
}
}
]
}
]
}
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-11-12 | The response structure of the API has changed | View Change Details |
| 2024-10-24 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
| 2024-08-26 | The internal configuration of the API is changed, but the call is not affected | View Change Details |