Updated on 2025-11-17 GMT+08:00

Obtaining the Instance Result

Function

This API is used to obtain the instance result.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/quality/instances/{instance_id}/result

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain it, see Project ID and Account ID.

instance_id

Yes

String

Instance ID. For details about how to obtain it, see the interface return result of Obtaining the Task Execution Result List.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

limit

No

Long

Number of paging entries, value range [0,100].

The default value is 10.

offset

No

Long

The paging offset, minimum value 0.

The default value is 0.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

workspace

Yes

String

DataArts Studio workspace ID. For details about how to obtain the workspace ID, see Instance ID and Workspace ID.

X-Auth-Token

Yes

String

IAM token. For details about how to obtain the token, see Authentication.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

count

Integer

The total number of subjobs

resources

Array of SubInstanceResult objects

Resource configuration ID for a subjob instance

Table 5 SubInstanceResult

Parameter

Type

Description

sub_rule_id

String

Sub-rule ID

sub_instance_instance_id

String

Sub-rule instance ID

abnormal_table_status

String

Abnormal table task status. Value UNSUPPORTED indicates that abnormal tables are not supported, READY indicates that the abnormal table is being prepared, RUNNING indicates that the abnormal table task is running, FAILED indicates that the abnormal table task fails, and SUCCESS indicates that the abnormal table task is successfully executed.

results

Array of objects

Result set

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code, for example, DQC.0000 which indicates that the request was successfully processed

error_msg

String

Error message

Example Requests

None

Example Responses

Status code: 200

Success

{
  "count" : 2,
  "resources" : [ {
    "sub_rule_id" : "1012386182602149888",
    "sub_instance_instance_id" : "1012386190718128129",
    "abnormal_table_status" : "UNSUPPORTED",
    "results" : [ {
      "Total Rows" : "4",
      "Status" : "false",
      "Name" : "1_database.dqc_test2"
    } ]
  }, {
    "sub_rule_id" : "1012386182631510017",
    "sub_instance_instance_id" : "1012386190718128128",
    "abnormal_table_status" : "UNSUPPORTED",
    "results" : [ {
      "Total Rows" : "4",
      "Status" : "false",
      "Name" : "1_database.dqc_test2"
    } ]
  } ]
}

Status Codes

Status Code

Description

200

Success

500

INTERNAL SERVER ERROR