ListJobInfos-阿里云帮助中心

Lists 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 sort column.	cuUsage
ascOrder	boolean	No	Specifies whether to sort the results in ascending 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 parameters.
extNodeIdList	array	No	The upstream node IDs.
	string	No	The upstream node IDs.	76358164
extNodeNameList	array	No	The upstream node names.
	string	No	The upstream node names.	ods_wfq_company_industry_di
from	integer	Yes	The start timestamp.	1672112000
instanceIdList	array	No	The job instance Id.
	string	No	The job instance Id.	20241028****jkl
jobOwnerList	array	No	The list of job owners.
	string	No	The job owner. Fuzzy matching is supported. Multiple values are combined with a logical OR.	ALIYUN$7632***@aliyun.com
priorityList	array	No	The job priorities.
	integer	No	The job priorities.	0
projectList	array	No	The project names.
	string	No	The project names.	projectA
quotaNickname	string	No	The quota nickname.	quota_nickname
sceneTagList	array	No	The intelligent diagnostics tags.
	string	No	The intelligent diagnosis tags.	SubscriptionLackResource
signatureList	array	No	The job signatures.
	string	No	The job signatures.	signatureabc
sortByList	array	No	The multi-column sort fields.
	string	No	The multi-column sort fields.	cuUsage
sortOrderList	array	No	The multi-column sort orders.
	string	No	The multi-column sort orders.	desc
statusList	array	No	The job statuses.
	string	No	The job statuses.	running
taskNameList	array	No	The job names.
	string	No	The job names.	console_query_task_1788796813532
to	integer	Yes	The end timestamp.	1672112130
typeList	array	No	The job types.
	string	No	The job types.	SQL

Response elements

Element	Type	Description	Example
	object	PopResult
data	object	The response data.
jobInfoList	array<object>	The list of job information.
	array<object>	The job information.
cluster	string	The cluster ID.	AY20A
cuSnapshot	number	The CU snapshot ratio of the job.	0.48
cuUsage	integer	The total CU usage.	10
endAtTime	integer	The end time of the execution. The value is a UNIX timestamp in seconds.	0
extNodeId	string	The DataWorks node ID.	node_4
extNodeName	string	The name of the external scheduling platform that submitted the job.	ods_wfq_company_industry_di
extNodeOnDuty	string	The person in charge of the execution.	duty_2
extPlantFrom	string	The upstream platform.	platform_3
extPlatformId	string	The identifier of the external scheduling platform that submitted the job.	dataworks
inputBytes	number	The amount of data scanned by the job. Unit: bytes.	1234
instanceId	string	The instance ID.	20230410050036549gfmsdwf60gg
jobOwner	string	The account that submitted the job.	ALIYUN$xxx@test.aliyunid.com
jobType	string	The job types.	SQL
memorySnapshot	number	The memory snapshot ratio of the job.	0.42
memoryUsage	integer	The total memory usage.	40
priority	integer	The priority.	1
project	string	The MaxCompute project name.	openrec_new
quotaNickname	string	The nickname of the quota used by the job.	my_quota
quotaType	string	The quota type.	subscription
region	string	The region ID.	cn-shanghai
roleSessionName	string	The role assumption used to commit the job.	aliyunservicerole
runningAtTime	integer	The start time of the job execution. The value is a UNIX timestamp in seconds.	1672112113
runningTime	integer	The execution duration. Unit: seconds.	800
sceneResults	array<object>	The intelligent diagnosis results.
	array<object>	The intelligent diagnosis results.
description	string	The details of the intelligent 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	The node information for data skew and data bloat. This parameter is returned only when the diagnosis scenario is data skew or data bloat.
	string	The node information for data skew and data bloat.	"jobinsight_data_skew_node": "Worker M1#10000_0"
scene	string	The scenario of the intelligent diagnosis result.	LackResource
sceneTag	string	The tag of the intelligent diagnosis result.	SubscriptionLackResource
summary	string	The summary of the intelligent diagnosis result.	Insufficient computing resources available for the job. Click to view details.
type	string	The type of the intelligent diagnosis result.	warning
signature	string	The SQL signature.	i094KijGrN3kOXZ74kbexB77XQY=
status	string	The status.	running
statusSnapshot	string	The snapshot status of the job.	running
submittedAtTime	integer	The submission time of the job. The value is a UNIX timestamp in seconds.	1672112013
tags	string	The tags.	[]
taskName	string	The task name.	console_query_task_1788796813532
tenantId	string	The tenant ID.	213065738244354
totalTime	integer	The total execution duration.	900
waitingTime	integer	The waiting time. Unit: seconds.	100
pageNumber	integer	The current page number.	2
pageSize	integer	The number of entries per page.	10
totalCount	integer	The total number of returned entries.	64
httpCode	integer	Indicates whether the request is successful. If the value is not null and is not 200, the request failed.	200
requestId	string	The request ID.	0bc13a9516807484336515320e38f5

Examples

Success response

JSON format

{
  "data": {
    "jobInfoList": [
      {
        "cluster": "AY20A",
        "cuSnapshot": 0.48,
        "cuUsage": 10,
        "endAtTime": 0,
        "extNodeId": "node_4",
        "extNodeName": "ods_wfq_company_industry_di",
        "extNodeOnDuty": "duty_2",
        "extPlantFrom": "platform_3",
        "extPlatformId": "dataworks",
        "inputBytes": 1234,
        "instanceId": "20230410050036549gfmsdwf60gg",
        "jobOwner": "ALIYUN$xxx@test.aliyunid.com",
        "jobType": "SQL",
        "memorySnapshot": 0.42,
        "memoryUsage": 40,
        "priority": 1,
        "project": "openrec_new",
        "quotaNickname": "my_quota",
        "quotaType": "subscription",
        "region": "cn-shanghai",
        "roleSessionName": "aliyunservicerole",
        "runningAtTime": 1672112113,
        "runningTime": 800,
        "sceneResults": [
          {
            "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\""
            },
            "scene": "LackResource",
            "sceneTag": "SubscriptionLackResource",
            "summary": "Insufficient computing resources available for the job. Click to view details.",
            "type": "warning"
          }
        ],
        "signature": "i094KijGrN3kOXZ74kbexB77XQY=",
        "status": "running",
        "statusSnapshot": "running",
        "submittedAtTime": 1672112013,
        "tags": "[]",
        "taskName": "console_query_task_1788796813532",
        "tenantId": "213065738244354",
        "totalTime": 900,
        "waitingTime": 100
      }
    ],
    "pageNumber": 2,
    "pageSize": 10,
    "totalCount": 64
  },
  "httpCode": 200,
  "requestId": "0bc13a9516807484336515320e38f5"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.