GetJobInfo

Queries basic information about a job.

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:GetJobInfo

get

*Job

acs:odps:{#regionId}:{#accountId}:job/{#instanceId}

None

Request syntax

GET /api/v1/jobs/{instanceId}/info HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The job ID.	20230410****60gg

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element	Type	Description	Example
	object	The response body.
requestId	string	The request ID.	0be3e0bb16654558425251398e27a9
httpCode	integer	The HTTP status code. 1xx: informational. The request is received and being processed. 2xx: success. The request was received, understood, and accepted. 3xx: redirection. Further action is required to complete the request. 4xx: client error. The request contains invalid parameters or syntax, or a precondition cannot be met. 5xx: server error. The server failed to fulfill the request.	200
errorCode	string	The error code.	OBJECT_NOT_EXIST
errorMsg	string	The error message.	This object does not exist.
data	object	The returned data.
tenantId	string	The tenant ID.	4784****5249
region	string	The region ID.	cn-shanghai
instanceId	string	The job ID.	20230410****60gg
jobOwner	string	The job owner.	ALIYUN$7632***@aliyun.com
project	string	The project name.	dp_cdm_prod
jobType	string	The job type.	SQL
priority	integer	The job priority.	1
status	string	The job status.	running
quotaNickname	string	The nickname of the computing quota used by the job.	os_bigdata
quotaType	string	The quota type.	subscription
cuUsage	integer	The resources consumed by the job. Returned only for completed jobs. Unit: 100Cores.	10
memoryUsage	integer	The memory consumed by the job. Returned only for completed jobs. Unit: MB*s.	40
submittedAtTime	integer	The time when the job was submitted.	1672112013
waitingTime	integer	The duration from job submission to execution start.	100
runningAtTime	integer	The time when the job received its first computing resources. For short-lived or resource-free jobs (such as DDL jobs), the submission time is used instead.	1672112113
runningTime	integer	The duration from job start to job end.	800
endAtTime	integer	The end time of the job.	1672112913
totalTime	integer	The total duration from job submission to termination.	900
signature	string	The SQL job signature. Use this value to locate all instances where an SQL statement was executed.	20c1efb4a7caca1865f4aa784bb500efae74af04
extPlantFrom	string	The upstream platform.	platform_3
extNodeId	string	The ID of the ancestor node.	node_4
extNodeOnDuty	string	The Alibaba Cloud account ID of the task owner.	duty_2
inputBytes	number	The amount of data scanned by the job.	1234
sceneResults	array<object>	The intelligent diagnostics results.
	array<object>	The intelligent diagnostics result items.
sceneTag	string	The intelligent diagnostics result tag.	SubscriptionLackResource
scene	string	The intelligent diagnostics scenario.	LackResource
type	string	The intelligent diagnostics result type.	warning
summary	string	The intelligent diagnostics result summary.	Insufficient computing resources available for the job. Click to view details.
description	string	The intelligent diagnostics result 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	object	Node information for data skew or data expansion diagnostics. Returned only when the scenario is data skew or data expansion.
	string	Node information for data skew or data expansion diagnostics.	"jobinsight_data_skew_node": "Worker M1#10000_0"
jobSubStatusList	array<object>	The job lifecycle substatuses.
	object	The job substatus.
code	integer	The substatus code.	1010
startTime	string	The start time of the substatus.	2025-03-05 00:04:15.717364 +0800
description	string	The description of the substatus.	Waiting for scheduling

Examples

Success response

JSON format

{
  "requestId": "0be3e0bb16654558425251398e27a9",
  "httpCode": 200,
  "errorCode": "OBJECT_NOT_EXIST",
  "errorMsg": "This object does not exist.",
  "data": {
    "tenantId": "4784****5249",
    "region": "cn-shanghai",
    "instanceId": "20230410****60gg",
    "jobOwner": "ALIYUN$7632***@aliyun.com\n",
    "project": "dp_cdm_prod",
    "jobType": "SQL\n",
    "priority": 1,
    "status": "running",
    "quotaNickname": "os_bigdata",
    "quotaType": "subscription",
    "cuUsage": 10,
    "memoryUsage": 40,
    "submittedAtTime": 1672112013,
    "waitingTime": 100,
    "runningAtTime": 1672112113,
    "runningTime": 800,
    "endAtTime": 1672112913,
    "totalTime": 900,
    "signature": "20c1efb4a7caca1865f4aa784bb500efae74af04",
    "extPlantFrom": "platform_3",
    "extNodeId": "node_4",
    "extNodeOnDuty": "duty_2",
    "inputBytes": 1234,
    "sceneResults": [
      {
        "sceneTag": "SubscriptionLackResource",
        "scene": "LackResource",
        "type": "warning",
        "summary": "\t\nInsufficient 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\"\n"
        }
      }
    ],
    "jobSubStatusList": [
      {
        "code": 1010,
        "startTime": "2025-03-05 00:04:15.717364 +0800",
        "description": "Waiting for scheduling"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.