查看作业列表
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
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 | long | 否 | 分页页码。 | 1 |
pageSize | long | 否 | 每页返回数目 | 10 |
body | object | 否 | 请求体参数 | |
from | long | 是 | 起始时间戳 | 1672112000 |
to | long | 是 | 截止时间戳 | 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 | 否 | 作业优先级 | |
long | 否 | 作业优先级 | 0 | |
sortByList | array | 否 | 多列排序字段 | |
string | 否 | 多列排序字段 | cuUsage | |
sortOrderList | array | 否 | 多列排序方式 | |
string | 否 | 多列排序方式 | desc | |
sceneTagList | array | 否 | 智能诊断标签 | |
string | 否 | 智能诊断标签 | SubscriptionLackResource |
返回参数
示例
正常返回示例
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\""
}
}
]
}
]
}
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-11-12 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2024-10-24 | API 内部配置变更,不影响调用 | 查看变更详情 |
2024-08-26 | API 内部配置变更,不影响调用 | 查看变更详情 |