ListJobInfos - MaxCompute - Alibaba Cloud Documentation Center

Views a list of jobs.

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

There is currently no authorization information disclosed in the API.

Request syntax

POST /api/v1/jobs HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
tenantId	string	No	The tenant ID.	478403690625249
region	string	No	The region ID.	cn-shanghai
orderColumn	string	No	The column based on which you want to sort query results.	cuUsage
ascOrder	boolean	No	Specifies whether to sort query results in ascending or descending order.	true
pageNumber	long	No	The page number.	1
pageSize	long	No	The number of entries per page.	10
body	string	No	The request body parameters.	{ "from":1672112000, "to":1672112130, "statusList":[], "quotaNickname":"quota_nickname", "projectList":[], "typeList":[], "jobOwnerList":[], "signatureList":[], "extNodeIdList":[], "instanceIdList":[], "priorityList":[], "settings":{ "key":"value" } }

Response parameters

Parameter	Type	Description	Example
	object	The returned data.
requestId	string	The request ID.	0bc13a9516807484336515320e38f5
httpCode	integer	Indicates whether the request was successful. If this parameter was not empty and the value of this parameter was not 200, the request failed.	200
data	object	The returned data.
totalCount	long	The total number of returned entries.	64
pageNumber	long	The page number.	2
pageSize	long	The number of entries per page.	10
jobInfoList	array<object>	The list of the information about the jobs.
jobInfoList	object
tenantId	string	The tenant ID.	213065738244354
region	string	The region ID.	cn-shanghai
cluster	string	The cluster ID.	AY20A
instanceId	string	The instance ID.	20230410050036549gfmsdwf60gg
jobOwner	string	The account that commits the job.	ALIYUN$xxx@test.aliyunid.com
project	string	The name of the MaxCompute project.	openrec_new
jobType	string	The type of the job.	SQL
priority	long	The priority of the job.	1
status	string	The status of the job.	running
quotaNickname	string	The nickname of the quota that is used by the job.	my_quota
quotaType	string	The type of the quota.	subscription
cuUsage	long	The total number of used compute units (CUs).	10
memoryUsage	long	The total memory usage.	40
cuSnapshot	double	The CU snapshot proportion of the job.	0.48
memorySnapshot	double	The memory snapshot proportion of the job.	0.42
statusSnapshot	string	The status of the snapshot.	running
submittedAtTime	long	The time when the job was committed.	1672112013
waitingTime	long	The duration for which the job waits to start.	100
runningAtTime	long	The time when the job starts to run.	1672112113
runningTime	long	The period for which the job runs.	800
endAtTime	long	The time when the job stops running.	0
totalTime	long	The total period for which the job runs.	900
signature	string	The signature of the SQL job.	i094KijGrN3kOXZ74kbexB77XQY=
extPlantFrom	string	The upstream platform.	platform_3
extNodeId	string	The node ID of DataWorks.	node_4
extNodeOnDuty	string	The account of the node owner.	duty_2
tags	string	The tags.	[]

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-08-26	The internal configuration of the API is changed, but the call is not affected	View Change Details