Obtaining Comparison Job Details
Function
This API is used to obtain the details of a comparison job.
Calling Method
For details, see Calling APIs.
URI
GET /v2/{project_id}/quality/consistency-tasks/{id}
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Project ID. For details about how to obtain it, see Project ID and Account ID. |
| id | Yes | String | Comparison job ID |
Request 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
| Parameter | Type | Description |
|---|---|---|
| id | Long | Job ID |
| name | String | Job name |
| description | String | Job description |
| category_id | Long | Catalog ID |
| level | String | Alarm severity. SUGGEST indicates warning, MINOR indicates minor, MAJOR indicates major, and FATAL indicates fatal. |
| alarm_condition | String | Unified alarm condition |
| alarm_notify | Boolean | Whether to enable alarm notifications |
| alarm_notify_type | String | Alarm notification type. TRIGGER_ALARM indicates that an alarm is triggered. RUN_SUCCESS indicates that the execution is successful. TRIGGER_ALARM_AND_RUNNING_SUCCESS indicates that an alarm is triggered and that the execution is successful. |
| alarm_notify_topic | String | Notification topic name |
| schedule_type | String | Scheduling type. The value can be ONCE (one-off scheduling) or PERIODIC (periodic scheduling). |
| schedule_period | String | Scheduling period. The value can be MINUTE, HOUR, DAY, or WEEK. |
| schedule_interval | String | Scheduling interval. When the scheduling period is minute, hour, or day, the scheduling interval is a number. When the scheduling period is week, the scheduling interval is days in a week, for example, MONDAY,TUESDAY. |
| schedule_start_time | String | Scheduling start time |
| schedule_end_time | String | Scheduling end time |
| create_time | Long | Last execution time. The value is a 13-digit timestamp accurate to millisecond. |
| last_run_time | Long | Last execution time. The value is a 13-digit timestamp accurate to millisecond. |
| sub_rules | Array of ConsistencyRuleDetailForOpenApi objects | Sub-rules |
| Parameter | Type | Description |
|---|---|---|
| id | Long | Sub-rule ID |
| sub_rule_name | String | Sub-rule name |
| type | String | Rule type. SingleDatabase indicates a database rule, SingleTable indicates a table rule, SingleColumn indicates a field rule, CrossColumn indicates a cross-field rule, and Customize indicates a custom rule. |
| template_id | Long | Rule template ID |
| connection | String | Data connection ID |
| connection_type | String | Data connection type |
| databases | String | Database names. Use commas (,) to separate multiple values. |
| sql | String | SQL script in the custom rule |
| tables | String | Table names. Use commas (,) to separate multiple values. |
| reference_tables | String | Reference table names. Use commas (,) to separate multiple values. |
| columns | String | Field names. Use commas (,) to separate multiple values. |
| reference_columns | String | Reference column names. Use commas (,) to separate multiple values. |
| dimension | String | Dimension |
| queue | String | DLI queue |
| regular_expression | String | Regular expression as the rule template |
| template_arguments | String | Template parameters |
| weight | Integer | Rule weight |
| calculation_range | String | Calculation range |
| calculation_range_sql | String | Calculation range SQL |
| alarm_condition | String | Alarm expression |
Status code: 400
| 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
| 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
The API call is successful. InstanceVO is returned.
{
"id" : 1012386182149165000,
"name" : "test",
"description" : "",
"level" : "SUGGEST",
"alarm_condition" : null,
"alarm_notify" : false,
"alarm_notify_type" : null,
"alarm_notify_topic" : null,
"schedule_type" : "ONCE",
"schedule_period" : null,
"schedule_interval" : null,
"schedule_start_time" : null,
"schedule_end_time" : null,
"category_id" : 0,
"create_time" : 1661413275050,
"last_run_time" : null,
"sub_rules" : [ {
"id" : 1012386182602149900,
"sub_rule_name" : "qew",
"type" : "SingleTable",
"connection" : "43b9e6315eda4918970cfcbbbfb74cb1",
"connection_type" : "DWS",
"databases" : "1_database",
"sql" : "",
"tables" : "1_database.dqc_test2",
"reference_tables" : null,
"columns" : "",
"reference_columns" : null,
"dimension" : null,
"queue" : "dlf_notdelete",
"regular_expression" : null,
"template_arguments" : null,
"weight" : 5,
"calculation_range" : "FULL_SCAN",
"calculation_range_sql" : "",
"alarm_condition" : "${1_1}>${2_1}",
"template_id" : 1
}, {
"id" : 1012386182631510000,
"sub_rule_name" : "qew",
"type" : "SingleTable",
"connection" : "43b9e6315eda4918970cfcbbbfb74cb1",
"connection_type" : "DWS",
"databases" : "1_database",
"sql" : "",
"tables" : "1_database.dqc_test2",
"reference_tables" : null,
"columns" : "",
"reference_columns" : null,
"dimension" : null,
"queue" : "dlf_notdelete",
"regular_expression" : null,
"template_arguments" : null,
"weight" : 5,
"calculation_range" : "FULL_SCAN",
"calculation_range_sql" : "",
"alarm_condition" : "${1_1}>${2_1}",
"template_id" : 1
} ]
} Status Codes
| Status Code | Description |
|---|---|
| 200 | The API call is successful. InstanceVO is returned. |
| 400 | BadRequest |
| 500 | INTERNAL SERVER ERROR |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.