Help Center/ DataArts Studio/ API Reference/ DataArts Quality APIs/ Task Instances/ Rerunning a Quality Job or Comparison Job
Updated on 2026-04-22 GMT+08:00

Rerunning a Quality Job or Comparison Job

Function

This API is used to rerun a data quality job or comparison job.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

POST /v2/{project_id}/quality/instances/restart

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.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

workspace

Yes

String

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

X-Auth-Token

Yes

String

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

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

rule_type

No

Integer

Job type. Value 1 indicates a quality job and value 2 indicates a comparison job.

rule_id

No

String

Job ID. You can obtain it by calling the API for obtaining the quality job list or the API for obtaining the comparison job list.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

instance_id

String

Instance ID. You can obtain it by calling the API for obtaining the quality job list.

Status code: 400

Table 5 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

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

Rerun a quality job.

POST https://{endpoint}/v2/{project_id}/quality/instances/restart

{
  "rule_type" : 1,
  "rule_id" : "1440764172232392705"
}

Example Responses

None

Status Codes

Status Code

Description

200

Success

400

BadRequest

500

INTERNAL SERVER ERROR