ListJobInfos - MaxCompute - Alibaba Cloud Documentation Center

Retrieves a list of jobs.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

odps:ListJobInfos

list

*All Resource

*

None

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 to use for sorting.	cuUsage
ascOrder	boolean	No	Specifies whether to sort the results in ascending or descending order.	true
pageNumber	integer	No	The page number.	1
pageSize	integer	No	The number of entries to return on each page.	10
body	object	No	The request body.	{ "from":1672112000, "to":1672112130, "statusList":[], "quotaNickname":"quota_nickname", "projectList":[], "typeList":[], "jobOwnerList":[], "signatureList":[], "extNodeIdList":[], "instanceIdList":[], "priorityList":[], "settings":{ "key":"value" } }
from	integer	Yes	The start UNIX timestamp.	1672112000
to	integer	Yes	The end UNIX timestamp.	1672112130
quotaNickname	string	No	The nickname of the quota.	quota_nickname
projectList	array	No	The project name.
	string	No	The project name.	projectA
typeList	array	No	The job type.
	string	No	The job type.	SQL
jobOwnerList	array	No	The job owner.
	string	No	The job owner.	ALIYUN$7632***@aliyun.com
signatureList	array	No	The job signature.
	string	No	The job signature.	signatureabc
extNodeIdList	array	No	The upstream node ID.
	string	No	The upstream node ID.	76358164
instanceIdList	array	No	The job instance ID.
	string	No	The job instance ID.	20241028****jkl
statusList	array	No	The job status.
	string	No	The job status.	running
priorityList	array	No	The job priority.
	integer	No	The job priority.	0
sortByList	array	No	The fields for multi-column sorting.
	string	No	A field for multi-column sorting.	cuUsage
sortOrderList	array	No	The sort orders for multi-column sorting.
	string	No	A sort order for multi-column sorting.	desc
sceneTagList	array	No	The smart diagnosis tag.
	string	No	A smart diagnosis tag.	SubscriptionLackResource
extNodeNameList	array	No
	string	No
taskNameList	array	No
	string	No

Response elements

Element	Type	Description	Example
	object	PopResult<ListJobInfoDto>
requestId	string	The request ID.	0bc13a9516807484336515320e38f5
httpCode	integer	Indicates whether the business logic was successful. A value other than 200 indicates a failure.	200
data	object	The returned data.
totalCount	integer	The total number of entries returned.	64
pageNumber	integer	The page number.	2
pageSize	integer	The number of entries per page.	10
jobInfoList	array<object>	The list of job information.
	array<object>	The job information.
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 submitted the job.	ALIYUN$xxx@test.aliyunid.com
project	string	The name of the MaxCompute project.	openrec_new
jobType	string	The job type.	SQL
priority	integer	The priority.	1
status	string	The status.	running
quotaNickname	string	The nickname of the quota that the job uses.	my_quota
quotaType	string	The quota type.	subscription
cuUsage	integer	The total CUs used.	10
memoryUsage	integer	The total memory used.	40
cuSnapshot	number	The proportion of CUs in the job snapshot.	0.48
memorySnapshot	number	The proportion of memory in the job snapshot.	0.42
statusSnapshot	string	The status of the job snapshot.	running
submittedAtTime	integer	The time when the job was submitted.	1672112013
waitingTime	integer	The waiting time.	100
runningAtTime	integer	The time when the job started to run.	1672112113
runningTime	integer	The runtime.	800
endAtTime	integer	The time when the job finished.	0
totalTime	integer	The total runtime.	900
signature	string	The SQL signature.	i094KijGrN3kOXZ74kbexB77XQY=
extPlantFrom	string	The upstream platform.	platform_3
extNodeId	string	The ID of the DataWorks node.	node_4
extNodeOnDuty	string	The person in charge of the execution.	duty_2
tags	string	The tags.	[]
sceneResults	array<object>	The smart diagnosis results.
	array<object>	The smart diagnosis results.
sceneTag	string	The tag of the smart diagnosis result.	SubscriptionLackResource
scene	string	The scenario of the smart diagnosis result.	LackResource
type	string	The type of the smart diagnosis result.	warning
summary	string	A summary of the smart diagnosis result.	Insufficient computing resources available for the job. Click to view details.
description	string	The details of the smart diagnosis result.	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	object	Information about the nodes that have data skew or data bloat. This parameter is returned only when the diagnosis scenario is data skew or data bloat.
	string	Information about the nodes that have data skew or data bloat.	"jobinsight_data_skew_node": "Worker M1#10000_0"
inputBytes	number	The amount of data scanned by the job. Unit: bytes.	1234
extPlatformId	string
extNodeName	string
taskName	string

Examples

Success response

JSON format

{
  "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\""
            }
          }
        ],
        "inputBytes": 1234,
        "extPlatformId": "",
        "extNodeName": "",
        "taskName": ""
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.