获取某个时间点的作业快照数据。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
odps:ListJobSnapshotInfos |
list |
*全部资源
|
无 | 无 |
请求语法
POST /api/v1/jobs/snapshot HTTP/1.1
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| tenantId |
string |
否 |
租户 ID。可以通过登录 MaxCompute 控制台,在左侧导航栏选择租户管理>租户属性查看。 |
478403690625249 |
| region |
string |
否 |
地域 ID。 |
cn-chengdu |
| orderColumn |
string |
否 |
排序列。支持:
|
cpuUsage |
| ascOrder |
boolean |
否 |
是否升序排列。 |
true |
| pageNumber |
integer |
否 |
分页页码。 |
1 |
| pageSize |
integer |
否 |
分页大小,每页做多显示的返回结果数量。 |
10 |
| body |
object |
否 |
请求体参数。 |
|
| from |
integer |
否 |
起始时间戳。 说明
该参数无效。截止时间戳为需要查看的快照时间点。 |
1706840714 |
| to |
integer |
是 |
截止时间戳。 |
1706840714 |
| quotaNickname |
string |
否 |
作业使用的计算 Quota 昵称。 |
quota_A |
| projectList |
array |
否 |
项目名称。 |
|
|
string |
否 |
项目名称。 |
projectA |
|
| typeList |
array |
否 |
作业类型。 |
|
|
string |
否 |
作业类型。 |
SQL |
|
| jobOwnerList |
array |
否 |
作业 owner。 |
|
|
string |
否 |
作业 owner。 |
ALIYUN$7632***@aliyun.com |
|
| signatureList |
array |
否 |
SQL 作业签名。 |
|
|
string |
否 |
SQL 作业签名。 |
signatureabc |
|
| extNodeIdList |
array |
否 |
上游节点 ID。 |
|
|
string |
否 |
上游节点 ID。 |
76358164 |
|
| instanceIdList |
array |
否 |
作业实例(Instance)Id。 |
|
|
string |
否 |
作业实例(Instance)Id。 |
20241028****jkl |
|
| statusList |
array |
否 |
作业状态。 |
|
|
string |
否 |
作业状态。 |
running |
|
| priorityList |
array |
否 |
作业优先级。 |
|
|
integer |
否 |
作业优先级。 |
9 |
|
| sortByList |
array |
否 |
多列排序字段。 |
|
|
string |
否 |
多列排序字段。 |
cuUsage |
|
| sortOrderList |
array |
否 |
多列排序方式。 |
|
|
string |
否 |
多列排序方式。 |
desc |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
PopResult |
||
| requestId |
string |
请求 ID。 |
0b87b7e716665825896565060e87a4 |
| httpCode |
integer |
HTTP 状态码。
|
200 |
| errorCode |
string |
错误码。 |
OBJECT_NOT_EXIST |
| errorMsg |
string |
错误信息。 |
异常信息 |
| data |
object |
请求返回结果。 |
|
| jobInfoList |
array<object> |
作业快照列表。 |
|
|
object |
作业快照信息。 |
||
| tenantId |
string |
租户 ID。 |
213065738244354 |
| region |
string |
地域 ID。 |
cn-chengdu |
| instanceId |
string |
作业 ID。 |
20241028****jkl |
| jobOwner |
string |
作业 Owner。 |
ALIYUN$7632***@aliyun.com |
| project |
string |
项目名称。 |
projectA |
| jobType |
string |
作业类型。 |
SQL |
| priority |
integer |
作业优先级。 |
9 |
| status |
string |
作业状态。 说明
快照作业状态只有 running。 |
running |
| quotaNickname |
string |
作业使用的计算 Quota 昵称。 |
quota_A |
| quotaType |
string |
Quota 类型。 |
subscription |
| cpuUsage |
integer |
作业在快照时间点的 CPU 使用量。单位:Core。 |
100 |
| memoryUsage |
integer |
作业在快照时间点的内存使用量。单位:MB。 |
409600 |
| maxCpuPct |
number |
无需关注。 |
-1 |
| minCpuPct |
number |
包年包月作业在快照时间点的 CPU 使用占比(CPU 使用量/(预留 CPU 保障+弹性预留 CPU))。按量付费作业无此参数。 |
0.6 |
| maxMemoryPct |
number |
无需关注。 |
-1 |
| minMemoryPct |
number |
包年包月作业在观测时刻的内存使用占比(内存使用量/(预留内存保障+弹性预留内存))。按量付费作业无此参数。 |
0.6 |
| submittedAtTime |
integer |
作业提交时间。 |
1736821785 |
| waitingTime |
integer |
等待时长。作业从提交时间到开始运行时间的时长。若暂无开始运行时间,则为提交时间到快照时间的时长。单位:s。 |
20 |
| runningAtTime |
integer |
作业的开始运行时间。 说明
作业获取第一份计算资源的时间。 |
1736821805 |
| runningTime |
integer |
运行时长。作业从开始运行时间到快照时间点的时长。若暂无开始运行时间,则为空。单位:s。 |
43 |
| snapshotTime |
integer |
快照时间。 |
1736821848 |
| totalTime |
integer |
总时长。作业从提交时间到快照时间点的时长。单位:s。 |
63 |
| signature |
string |
SQL 作业签名。 |
signatureabc |
| extPlantFrom |
string |
上游平台。 |
Dataworks |
| extNodeId |
string |
上游节点 ID。 |
76358164 |
| extNodeOnDuty |
string |
任务负责人账号 ID。 |
duty_2 |
| cpuRequest |
integer |
作业在快照时间点的 CPU 请求量。单位:Core。 |
200 |
| memoryRequest |
integer |
作业在快照时间点的内存请求量。单位:MB。 |
409600 |
| cpuUsageToRequestRatio |
number |
作业在快照时间点的 CPU 满足率(CPU 使用量/CPU 请求量)。 |
0.5 |
| memoryUsageToRequestRatio |
number |
作业在快照时间点的内存满足率(内存使用量/内存请求量)。 |
1 |
| extPlatformId |
string |
||
| totalCount |
integer |
返回结果的总数量。 |
123 |
| pageNumber |
integer |
当前页码。 |
1 |
| pageSize |
integer |
每页记录数。 |
10 |
示例
正常返回示例
JSON格式
{
"requestId": "0b87b7e716665825896565060e87a4",
"httpCode": 200,
"errorCode": "OBJECT_NOT_EXIST",
"errorMsg": "异常信息",
"data": {
"jobInfoList": [
{
"tenantId": "213065738244354",
"region": "cn-chengdu",
"instanceId": "20241028****jkl",
"jobOwner": "ALIYUN$7632***@aliyun.com",
"project": "projectA",
"jobType": "SQL",
"priority": 9,
"status": "running",
"quotaNickname": "quota_A",
"quotaType": "subscription",
"cpuUsage": 100,
"memoryUsage": 409600,
"maxCpuPct": -1,
"minCpuPct": 0.6,
"maxMemoryPct": -1,
"minMemoryPct": 0.6,
"submittedAtTime": 1736821785,
"waitingTime": 20,
"runningAtTime": 1736821805,
"runningTime": 43,
"snapshotTime": 1736821848,
"totalTime": 63,
"signature": "signatureabc",
"extPlantFrom": "Dataworks",
"extNodeId": "76358164",
"extNodeOnDuty": "duty_2",
"cpuRequest": 200,
"memoryRequest": 409600,
"cpuUsageToRequestRatio": 0.5,
"memoryUsageToRequestRatio": 1,
"extPlatformId": ""
}
],
"totalCount": 123,
"pageNumber": 1,
"pageSize": 10
}
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。