ListJobSnapshotInfos - MaxCompute - Alibaba Cloud Documentation Center

This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Views a list of job snapshot data at a specific point in time.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
odps:ListJobSnapshotInfos	list	All Resources ``	none	none

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
tenantId	string	No	The ID of the tenant. You can log on to the MaxCompute console, and choose Tenants > Tenant Property from the left-side navigation pane to view the tenant ID.	478403690625249
region	string	No	The region ID.	cn-chengdu
orderColumn	string	No	The sorting column.	cpuUsage
ascOrder	boolean	No	Specifies whether to sort data in ascending order.	true
pageNumber	long	No	The page number.	1
pageSize	long	No	The number of entries per page.	10
body	object	No	The request body.
from	long	No	Start timestamp. Note This parameter is invalid. The end timestamp should be the time point for the snapshot you want to view.	1706840714
to	long	Yes	End timestamp.	1706840714
quotaNickname	string	No	The nickname of the compute Quota used by the job.	quota_A
projectList	array	No	The name of project.
	string	No	The name of project.	projectA
typeList	array	No	The type of the job.
	string	No	The type of the job.	SQL
jobOwnerList	array	No	The account that commits the job.
	string	No	The account that commits the job.	ALIYUN$7632***@aliyun.com
signatureList	array	No	The signature of the SQL job.
	string	No	The signature of the SQL job.	signatureabc
extNodeIdList	array	No	The ID of the upstream node.
	string	No	The ID of the upstream node.	76358164
instanceIdList	array	No	The instance ID.
	string	No	The instance ID.	20241028****jkl
statusList	array	No	The status of jobs.
	string	No	The status of jobs.	running
priorityList	array	No	The priority of the job.
	long	No	The priority of the job.	9
sortByList	array	No	The sorting columns.
	string	No	The sorting columns.	cuUsage
sortOrderList	array	No	The orders for the sorting columns.
	string	No	The orders for the sorting columns.	desc

Response parameters

Parameter	Type	Description	Example
	object	PopResult
requestId	string	The request ID.	0b87b7e716665825896565060e87a4
httpCode	integer	The HTTP status code. 1xx: informational response. The request is received and is being processed. 2xx: success. The request is successfully received, understood, and accepted by the server. 3xx: redirection. The request is redirected, and further actions are required to complete the request. 4xx: client error. The request contains invalid request parameters or syntaxes, or specific request conditions cannot be met. 5xx: server error. The server cannot meet requirements due to other reasons.	200
errorCode	string	The error code.	OBJECT_NOT_EXIST
errorMsg	string	The error message.	this quota is not exist.
data	object	The returned data.
jobInfoList	array<object>	The job snapshots.
jobInfoList	object	The information about the job snapshots.
tenantId	string	The tenant ID.	213065738244354
region	string	The region ID.	cn-chengdu
instanceId	string	The instance ID.	20241028****jkl
jobOwner	string	The account that commits the job.	ALIYUN$7632***@aliyun.com
project	string	The name of the MaxCompute project.	projectA
jobType	string	The type of the job.	SQL
priority	long	The priority of the job.	9
status	string	The snapshot status of the job. Note The snapshot status is only running.	running
quotaNickname	string	The nickname of the computing Quota used by the job.	quota_A
quotaType	string	The type of the quota.	subscription
cpuUsage	long	CPU usage of the job at the snapshot time. Unit: Core.	100
memoryUsage	long	Memory usage of the job at the snapshot time. Unit: MB.	409600
maxCpuPct	double	Not applicable.	-1
minCpuPct	double	The CPU usage ratio of the annual or monthly subscription job at the snapshot time (CPU usage / (reserved CPU guarantee + elastic reserved CPU)). This parameter is not available for pay-as-you-go jobs.	0.6
maxMemoryPct	double	Not applicable.	-1
minMemoryPct	double	The memory usage ratio of the annual or monthly subscription job at the observation time (memory usage / (reserved memory guarantee + elastic reserved memory)). This parameter is not available for pay-as-you-go jobs.	0.6
submittedAtTime	long	The time when the job was committed.	1736821785
waitingTime	long	The duration from the time the job is submitted to the time the job starts to run. Unit: seconds (s).	20
runningAtTime	long	The start time of the job. Note The time when the job received the first batch of computing resources.	1736821805
runningTime	long	The running duration, which is the duration from the runningAtTime to the snapshotTime of the job. Unit: seconds (s).	43
snapshotTime	long	The snapshot time.	1736821848
totalTime	long	The interval from the time when the job was submitted to the snapshotTime .Unit: seconds (s).	63
signature	string	The signature of the SQL job.	signatureabc
extPlantFrom	string	The upstream platform.	Dataworks
extNodeId	string	The ID of the upstream node.	76358164
extNodeOnDuty	string	The account ID of the task owner.	duty_2
cpuRequest	long	The CPU request amount of the job at the snapshot time point. Unit: Core.	200
memoryRequest	long	The Memory request amount of the job at the snapshot time point. Unit: MB.	409600
cpuUsageToRequestRatio	double	The CPU satisfaction ratio of the job at the snapshot time point (cpuUsage/cpuRequest).	0.5
memoryUsageToRequestRatio	double	The Memory satisfaction ratio of the job at the snapshot time point (memoryUsage/memoryRequest).	1
totalCount	long	The total number of returned results.	123
pageNumber	long	The page number.	1
pageSize	long	The number of entries per page.	10

Examples

Sample success responses

JSONformat

{
  "requestId": "0b87b7e716665825896565060e87a4",
  "httpCode": 200,
  "errorCode": "OBJECT_NOT_EXIST",
  "errorMsg": "this quota is not exist.",
  "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
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2025-02-17	The response structure of the API has changed	View Change Details