文档

ListJobInfos - 查看作业列表

更新时间:

查看作业列表

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

POST /api/v1/jobs

请求参数

名称类型必填描述示例值
tenantIdstring

租户 id

478403690625249
regionstring

地域 id。

cn-shanghai
orderColumnstring

排序列

cuUsage
ascOrderboolean

升序 or 降序

true
pageNumberlong

分页页码。

1
pageSizelong

每页返回数目

10
bodystring

请求体参数

{ "from":1672112000, #起始时间戳 "to":1672112130, #截止时间戳 "statusList":[], #作业状态 "quotaNickname":"quota_nickname", #配额名称 "projectList":[], #项目名称 "typeList":[], #类型 "jobOwnerList":[], #作业owner "signatureList":[], #sql签名 "extNodeIdList":[], "instanceIdList":[], #实例ID "priorityList":[], #作业优先级 "settings":{ "key":"value" } }

返回参数

名称类型描述示例值
object

PopResult

requestIdstring

请求 id。

0bc13a9516807484336515320e38f5
httpCodeinteger

业务成功与否。如果非空且不是 200,那么表示业务处理失败。

200
dataobject

返回结果。

totalCountlong

返回结果的总数量。

64
pageNumberlong

当前页码。

2
pageSizelong

每页显示条数。

10
jobInfoListarray<object>

作业信息列表

object

作业信息

tenantIdstring

租户 ID

213065738244354
regionstring

地域 id。

cn-shanghai
clusterstring

集群 id

AY20A
instanceIdstring

实例 ID。

20230410050036549gfmsdwf60gg
jobOwnerstring

提交作业的账号

ALIYUN$xxx@test.aliyunid.com
projectstring

maxcompute 项目名称

openrec_new
jobTypestring

作业类型

SQL
prioritylong

优先级

1
statusstring

状态

running
quotaNicknamestring

作业使用的配额昵称

my_quota
quotaTypestring

quota 类型

subscription
cuUsagelong

cu 使用总量

10
memoryUsagelong

内存使用总量

40
cuSnapshotdouble

作业的 cu 快照占比

0.48
memorySnapshotdouble

作业的内存快照占比

0.42
statusSnapshotstring

作业快照状态

running
submittedAtTimelong

作业的提交时间

1672112013
waitingTimelong

等待时间

100
runningAtTimelong

作业的开始运行时间

1672112113
runningTimelong

运行时间

800
endAtTimelong

运行结束时间

0
totalTimelong

总运行时长

900
signaturestring

sql 签名

i094KijGrN3kOXZ74kbexB77XQY=
extPlantFromstring

上游平台

platform_3
extNodeIdstring

DataWorks 节点 ID

node_4
extNodeOnDutystring

执行责任人

duty_2
tagsstring

标签

[]

示例

正常返回示例

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": "[]"
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。