GetSemanticJobDetail-DataWorks(DataWorks)-阿里云帮助中心

Queries the executor status and runtime configuration by using the ExecutorJobId returned by RunSemanticJob or ListSemanticJobRuns.

Operation description

Scenarios

Queries the detailed status and runtime information of a semantic job run on the executor side. This is used to poll execution progress or troubleshoot run failures.

Procedure

Call RunSemanticJob or ListSemanticJobRuns to obtain the ExecutorJobId.
Use the ProjectId returned by the job definition as the ProjectId for this operation.
Determine the current status based on the executor details in Data. If the job is still running, continue polling this operation.

Related operations

To retrieve logs, call GetSemanticJobLog. To stop a run, call KillSemanticJob.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
ExecutorJobId	string	Yes	The executor job ID. Use the Data.ExecutorJobId from the RunSemanticJob response or the ExecutorJobId from a ListSemanticJobRuns record.	exec-job-demo
ProjectId	integer	Yes	The ID of the DataWorks workspace to which the job belongs. Use the ProjectId from the CreateSemanticJob response or a ListSemanticJobs list item.	100

Construct the request parameters based on the description of each request field.

Response elements

Element	Type	Description	Example
	object	The standard response for querying executor run details. Data contains the executor details currently returned for the specified ExecutorJobId.
RequestId	string	The request ID. Used for locating logs and troubleshooting issues.	676271D6-53B4-57BE-89FA-72F7AE1418DF
Success	boolean	Indicates whether the request was successful.
Data	object	The job details returned by the executor. Used to determine the run status and view the actual runtime configuration.
ExecutorJobId	string	The executor job ID.	exec-job-demo
FileType	integer	The node type code of the executor. Semantic jobs use Shell node code 6.	6
ProjectId	integer	The DataWorks workspace ID associated with the executor job.	100
Datasource	string	The data source identifier used by the executor job.	maxcompute
CodeParameters	string	The code parameter information returned by the executor. Used to troubleshoot the runtime configuration of this run.	--limit 100
Env	string	The runtime environment identifier returned by the executor.	PROD
CustomerName	string	The customer identifier of the executor job.	meta_semantic
CurrentSqlIndex	integer	The index of the SQL fragment currently being processed by the executor.	0
ExecTypes	array	The list of execution type codes returned by the executor.
	integer	The list of execution type codes returned by the executor.	6
Statuses	array	The list of status codes returned by the executor. Used to determine the current or final status of the job.
	integer	The list of job status codes returned by the executor. A successful status includes 3.	3
AdvanceSettings	object	The advanced runtime settings returned by the executor.
ResourceUrls	array<object>	The list of resource URLs associated with the executor job.
	object	The list of resource URLs returned by the executor.
ResourceGroupId	string	The ID of the resource group that actually executed the job.	rg-demo

For the meaning of response fields and their relationships to subsequent calls, refer to the description of each field.

Examples

Success response

JSON format

{
  "RequestId": "676271D6-53B4-57BE-89FA-72F7AE1418DF",
  "Success": false,
  "Data": {
    "ExecutorJobId": "exec-job-demo",
    "FileType": 6,
    "ProjectId": 100,
    "Datasource": "maxcompute",
    "CodeParameters": "--limit 100",
    "Env": "PROD",
    "CustomerName": "meta_semantic",
    "CurrentSqlIndex": 0,
    "ExecTypes": [
      6
    ],
    "Statuses": [
      3
    ],
    "AdvanceSettings": {
      "test": "test",
      "test2": 1
    },
    "ResourceUrls": [
      {
        "test": "test",
        "test2": 1
      }
    ],
    "ResourceGroupId": "rg-demo"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.