GetSemanticJobLog

Updated at:

Queries execution logs by using the ExecutorJobId returned by RunSemanticJob or ListSemanticJobRuns. The current POP contract exposes only the task and workspace identifiers and returns default log segments.

Operation description

Scenarios

Reads the execution logs of a semantic job run to observe the execution process and identify failure causes.

Procedure

  1. Specify the run by using RunSemanticJob.Data.ExecutorJobId or ListSemanticJobRuns[].ExecutorJobId.

  2. Call this operation with the ProjectId of the corresponding task.

  3. Analyze the log segments in Data together with the run status returned by GetSemanticJobDetail.

Before you begin

Logs are used for diagnostics and do not represent the final result files. Obtain result artifacts by calling DownloadSemanticResults.

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 task 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 execution logs. Data contains the list of log segments returned by the executor.

RequestId

string

The request ID. Used to locate logs and troubleshoot issues.

676271D6-53B4-57BE-89FA-72F7AE1418DF

Success

boolean

Indicates whether the request was successful.

Data

array<object>

The list of log segments returned by the executor. The current POP contract does not expose sqlIndex or offset externally. Log segments are returned based on the default behavior of the operation.

object

A log segment.

LogEnd

boolean

Indicates whether the current log segment has been read to the end. A value of true indicates that no more content follows this segment.

LogContent

string

The raw log text returned in this response.

semantic job started

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": [
    {
      "LogEnd": false,
      "LogContent": "semantic job started"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.