ListJobSnapshotInfos - 获取作业快照列表

获取某个时间点的作业快照数据。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
odps:ListJobSnapshotInfoslist
*全部资源
*

请求语法

POST /api/v1/jobs/snapshot HTTP/1.1

请求参数

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

租户 ID。可以通过登录 MaxCompute 控制台,在左侧导航栏选择租户管理>租户属性查看。

478403690625249
regionstring

地域 ID。

cn-chengdu
orderColumnstring

排序列。支持:

  • submittedAtTime
  • waitingTime
  • runningAtTime
  • runningTime
  • snapshotTime
  • totalTime
  • cpuUsage
  • memoryUsage
  • minCpuPct
  • minMemoryPct
  • priority
  • cpuRequest
  • memoryRequest
  • cpuUsageToRequestRatio
  • memoryUsageToRequestRatio
cpuUsage
ascOrderboolean

是否升序排列。

true
pageNumberlong

分页页码。

1
pageSizelong

分页大小,每页做多显示的返回结果数量。

10
bodyobject

请求体参数。

fromlong

起始时间戳。

说明 该参数无效。截止时间戳为需要查看的快照时间点。
1706840714
tolong

截止时间戳。

1706840714
quotaNicknamestring

作业使用的计算 Quota 昵称。

quota_A
projectListarray

项目名称。

string

项目名称。

projectA
typeListarray

作业类型。

string

作业类型。

SQL
jobOwnerListarray

作业 owner。

string

作业 owner。

ALIYUN$7632***@aliyun.com
signatureListarray

SQL 作业签名。

string

SQL 作业签名。

signatureabc
extNodeIdListarray

上游节点 ID。

string

上游节点 ID。

76358164
instanceIdListarray

作业实例(Instance)Id。

string

作业实例(Instance)Id。

20241028****jkl
statusListarray

作业状态。

string

作业状态。

running
priorityListarray

作业优先级。

long

作业优先级。

9
sortByListarray

多列排序字段。

string

多列排序字段。

cuUsage
sortOrderListarray

多列排序方式。

string

多列排序方式。

desc

返回参数

名称类型描述示例值
object

PopResult

requestIdstring

请求 ID。

0b87b7e716665825896565060e87a4
httpCodeinteger

HTTP 状态码。

  • 1xx:信息响应 - 请求已接收,正在处理中。
  • 2xx:成功 - 请求动作已被服务端成功接收、理解并接受。
  • 3xx:重定向 - 请求被重定向,采取进一步行动以完成请求。
  • 4xx:客户端错误 - 请求包含错误请求参、语法或特定请求条件无法满足。
  • 5xx:服务端错误 - 服务器由于其他原因无法满足请求。
200
errorCodestring

错误码。

OBJECT_NOT_EXIST
errorMsgstring

错误信息。

异常信息
dataobject

请求返回结果。

jobInfoListarray<object>

作业快照列表。

jobInfoListobject

作业快照信息。

tenantIdstring

租户 ID。

213065738244354
regionstring

地域 ID。

cn-chengdu
instanceIdstring

作业 ID。

20241028****jkl
jobOwnerstring

作业 Owner。

ALIYUN$7632***@aliyun.com
projectstring

项目名称。

projectA
jobTypestring

作业类型。

SQL
prioritylong

作业优先级。

9
statusstring

作业状态。

说明 快照作业状态只有 running。
running
quotaNicknamestring

作业使用的计算 Quota 昵称。

quota_A
quotaTypestring

Quota 类型。

subscription
cpuUsagelong

作业在快照时间点的 CPU 使用量。单位:Core。

100
memoryUsagelong

作业在快照时间点的内存使用量。单位:MB。

409600
maxCpuPctdouble

无需关注。

-1
minCpuPctdouble

包年包月作业在快照时间点的 CPU 使用占比(CPU 使用量/(预留 CPU 保障+弹性预留 CPU))。按量付费作业无此参数。

0.6
maxMemoryPctdouble

无需关注。

-1
minMemoryPctdouble

包年包月作业在观测时刻的内存使用占比(内存使用量/(预留内存保障+弹性预留内存))。按量付费作业无此参数。

0.6
submittedAtTimelong

作业提交时间。

1736821785
waitingTimelong

等待时长。作业从提交时间到开始运行时间的时长。若暂无开始运行时间,则为提交时间到快照时间的时长。单位:s。

20
runningAtTimelong

作业的开始运行时间。

说明 作业获取第一份计算资源的时间。
1736821805
runningTimelong

运行时长。作业从开始运行时间到快照时间点的时长。若暂无开始运行时间,则为空。单位:s。

43
snapshotTimelong

快照时间。

1736821848
totalTimelong

总时长。作业从提交时间到快照时间点的时长。单位:s。

63
signaturestring

SQL 作业签名。

signatureabc
extPlantFromstring

上游平台。

Dataworks
extNodeIdstring

上游节点 ID。

76358164
extNodeOnDutystring

任务负责人账号 ID。

duty_2
cpuRequestlong

作业在快照时间点的 CPU 请求量。单位:Core。

200
memoryRequestlong

作业在快照时间点的内存请求量。单位:MB。

409600
cpuUsageToRequestRatiodouble

作业在快照时间点的 CPU 满足率(CPU 使用量/CPU 请求量)。

0.5
memoryUsageToRequestRatiodouble

作业在快照时间点的内存满足率(内存使用量/内存请求量)。

1
totalCountlong

返回结果的总数量。

123
pageNumberlong

当前页码。

1
pageSizelong

每页记录数。

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
      }
    ],
    "totalCount": 123,
    "pageNumber": 1,
    "pageSize": 10
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2025-02-17OpenAPI 返回结构发生变更查看变更详情