All Products
Search
Document Center

MaxCompute:ListJobInfos

Last Updated:Dec 09, 2024

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.

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:
    • The required resource types are displayed in bold characters.
    • 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.
OperationAccess levelResource typeCondition keyAssociated operation
odps:ListJobInfoslist
*All Resources
*
    none
none

Request syntax

POST /api/v1/jobs HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
tenantIdstringNo

The tenant ID.

478403690625249
regionstringNo

The region ID.

cn-shanghai
orderColumnstringNo

The column based on which you want to sort query results.

cuUsage
ascOrderbooleanNo

Specifies whether to sort query results in ascending or descending order.

true
pageNumberlongNo

The page number.

1
pageSizelongNo

The number of entries per page.

10
bodystringNo

The request body parameters.

{ "from":1672112000, "to":1672112130, "statusList":[], "quotaNickname":"quota_nickname", "projectList":[], "typeList":[], "jobOwnerList":[], "signatureList":[], "extNodeIdList":[], "instanceIdList":[], "priorityList":[], "settings":{ "key":"value" } }

Response parameters

ParameterTypeDescriptionExample
object

The returned data.

requestIdstring

The request ID.

0bc13a9516807484336515320e38f5
httpCodeinteger

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
dataobject

The returned data.

totalCountlong

The total number of returned entries.

64
pageNumberlong

The page number.

2
pageSizelong

The number of entries per page.

10
jobInfoListarray<object>

The list of the information about the jobs.

jobInfoListobject
tenantIdstring

The tenant ID.

213065738244354
regionstring

The region ID.

cn-shanghai
clusterstring

The cluster ID.

AY20A
instanceIdstring

The instance ID.

20230410050036549gfmsdwf60gg
jobOwnerstring

The account that commits the job.

ALIYUN$xxx@test.aliyunid.com
projectstring

The name of the MaxCompute project.

openrec_new
jobTypestring

The type of the job.

SQL
prioritylong

The priority of the job.

1
statusstring

The status of the job.

running
quotaNicknamestring

The nickname of the quota that is used by the job.

my_quota
quotaTypestring

The type of the quota.

subscription
cuUsagelong

The total number of used compute units (CUs).

10
memoryUsagelong

The total memory usage.

40
cuSnapshotdouble

The CU snapshot proportion of the job.

0.48
memorySnapshotdouble

The memory snapshot proportion of the job.

0.42
statusSnapshotstring

The status of the snapshot.

running
submittedAtTimelong

The time when the job was committed.

1672112013
waitingTimelong

The duration for which the job waits to start.

100
runningAtTimelong

The time when the job starts to run.

1672112113
runningTimelong

The period for which the job runs.

800
endAtTimelong

The time when the job stops running.

0
totalTimelong

The total period for which the job runs.

900
signaturestring

The signature of the SQL job.

i094KijGrN3kOXZ74kbexB77XQY=
extPlantFromstring

The upstream platform.

platform_3
extNodeIdstring

The node ID of DataWorks.

node_4
extNodeOnDutystring

The account of the node owner.

duty_2
tagsstring

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 timeSummary of changesOperation
2024-11-12The response structure of the API has changedView Change Details
2024-10-24The internal configuration of the API is changed, but the call is not affectedView Change Details
2024-08-26The internal configuration of the API is changed, but the call is not affectedView Change Details