查看作业列表
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
odps:ListJobInfos |
list |
*全部资源
|
无 | 无 |
请求语法
POST /api/v1/jobs HTTP/1.1
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| tenantId |
string |
否 |
租户 id |
478403690625249 |
| region |
string |
否 |
地域 id。 |
cn-shanghai |
| orderColumn |
string |
否 |
排序列 |
cuUsage |
| ascOrder |
boolean |
否 |
升序 or 降序 |
true |
| pageNumber |
integer |
否 |
分页页码。 |
1 |
| pageSize |
integer |
否 |
每页返回数目 |
10 |
| body |
object |
否 |
请求体参数 |
|
| from |
integer |
是 |
起始时间戳 |
1672112000 |
| to |
integer |
是 |
截止时间戳 |
1672112130 |
| quotaNickname |
string |
否 |
配额(Quota)昵称 |
quota_nickname |
| projectList |
array |
否 |
项目名称 |
|
|
string |
否 |
项目名称 |
projectA |
|
| typeList |
array |
否 |
作业类型 |
|
|
string |
否 |
作业类型 |
SQL |
|
| jobOwnerList |
array |
否 |
作业 owner |
|
|
string |
否 |
作业 owner |
ALIYUN$7632***@aliyun.com |
|
| signatureList |
array |
否 |
作业签名 |
|
|
string |
否 |
作业签名 |
signatureabc |
|
| extNodeIdList |
array |
否 |
上游节点 ID |
|
|
string |
否 |
上游节点 ID |
76358164 |
|
| instanceIdList |
array |
否 |
作业实例(Instance)Id |
|
|
string |
否 |
作业实例(Instance)Id |
20241028****jkl |
|
| statusList |
array |
否 |
作业状态 |
|
|
string |
否 |
作业状态 |
running |
|
| priorityList |
array |
否 |
作业优先级 |
|
|
integer |
否 |
作业优先级 |
0 |
|
| sortByList |
array |
否 |
多列排序字段 |
|
|
string |
否 |
多列排序字段 |
cuUsage |
|
| sortOrderList |
array |
否 |
多列排序方式 |
|
|
string |
否 |
多列排序方式 |
desc |
|
| sceneTagList |
array |
否 |
智能诊断标签 |
|
|
string |
否 |
智能诊断标签 |
SubscriptionLackResource |
|
| extNodeNameList |
array |
否 |
||
|
string |
否 |
|||
| taskNameList |
array |
否 |
||
|
string |
否 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
PopResult |
||
| requestId |
string |
请求 id。 |
0bc13a9516807484336515320e38f5 |
| httpCode |
integer |
业务成功与否。如果非空且不是 200,那么表示业务处理失败。 |
200 |
| data |
object |
返回结果。 |
|
| totalCount |
integer |
返回结果的总数量。 |
64 |
| pageNumber |
integer |
当前页码。 |
2 |
| pageSize |
integer |
每页显示条数。 |
10 |
| jobInfoList |
array<object> |
作业信息列表 |
|
|
array<object> |
作业信息 |
||
| tenantId |
string |
租户 ID |
213065738244354 |
| region |
string |
地域 id。 |
cn-shanghai |
| cluster |
string |
集群 id |
AY20A |
| instanceId |
string |
实例 ID。 |
20230410050036549gfmsdwf60gg |
| jobOwner |
string |
提交作业的账号 |
ALIYUN$xxx@test.aliyunid.com |
| project |
string |
maxcompute 项目名称 |
openrec_new |
| jobType |
string |
作业类型 |
SQL |
| priority |
integer |
优先级 |
1 |
| status |
string |
状态 |
running |
| quotaNickname |
string |
作业使用的配额昵称 |
my_quota |
| quotaType |
string |
quota 类型 |
subscription |
| cuUsage |
integer |
cu 使用总量 |
10 |
| memoryUsage |
integer |
内存使用总量 |
40 |
| cuSnapshot |
number |
作业的 cu 快照占比 |
0.48 |
| memorySnapshot |
number |
作业的内存快照占比 |
0.42 |
| statusSnapshot |
string |
作业快照状态 |
running |
| submittedAtTime |
integer |
作业的提交时间 |
1672112013 |
| waitingTime |
integer |
等待时间 |
100 |
| runningAtTime |
integer |
作业的开始运行时间 |
1672112113 |
| runningTime |
integer |
运行时间 |
800 |
| endAtTime |
integer |
运行结束时间 |
0 |
| totalTime |
integer |
总运行时长 |
900 |
| signature |
string |
sql 签名 |
i094KijGrN3kOXZ74kbexB77XQY= |
| extPlantFrom |
string |
上游平台 |
platform_3 |
| extNodeId |
string |
DataWorks 节点 ID |
node_4 |
| extNodeOnDuty |
string |
执行责任人 |
duty_2 |
| tags |
string |
标签 |
[] |
| sceneResults |
array<object> |
智能诊断结果。 |
|
|
array<object> |
智能诊断结果。 |
||
| sceneTag |
string |
智能诊断结果标签。 |
SubscriptionLackResource |
| scene |
string |
智能诊断结果场景。 |
LackResource |
| type |
string |
智能诊断结果类型。 |
warning |
| summary |
string |
智能诊断结果简述。 |
Insufficient computing resources available for the job. Click to view details. |
| description |
string |
智能诊断结果详情。 |
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 |
object |
数据倾斜、数据膨胀节点信息。只有当诊断场景为数据倾斜、数据膨胀时返回此参数。 |
|
|
string |
数据倾斜、数据膨胀节点信息。 |
"jobinsight_data_skew_node": "Worker M1#10000_0" |
|
| inputBytes |
number |
作业扫描量。单位 byte。 |
1234 |
| extPlatformId |
string |
||
| extNodeName |
string |
||
| taskName |
string |
示例
正常返回示例
JSON格式
{
"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\""
}
}
],
"inputBytes": 1234,
"extPlatformId": "",
"extNodeName": "",
"taskName": ""
}
]
}
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。