Obtaining Comparison Job Details
Function
This API is used to obtain the details of a comparison job.
URI
GET /v2/{project_id}/quality/consistency-tasks/{id}
| 
        Parameter  | 
      
        Mandatory  | 
      
        Type  | 
      
        Description  | 
     
|---|---|---|---|
| 
        project_id  | 
      
        Yes  | 
      
        String  | 
      
        projectId  | 
     
| 
        id  | 
      
        Yes  | 
      
        String  | 
      
        Comparison job ID  | 
     
Request Parameters
| 
        Parameter  | 
      
        Mandatory  | 
      
        Type  | 
      
        Description  | 
     
|---|---|---|---|
| 
        workspace  | 
      
        Yes  | 
      
        String  | 
      
        Workspace information  | 
     
| 
        X-Auth-Token  | 
      
        Yes  | 
      
        String  | 
      
        token  | 
     
Response Parameters
Status code: 200
| 
        Parameter  | 
      
        Type  | 
      
        Description  | 
     
|---|---|---|
| 
        id  | 
      
        Long  | 
      
        ID  | 
     
| 
        name  | 
      
        String  | 
      
        Job name  | 
     
| 
        description  | 
      
        String  | 
      
        Job description  | 
     
| 
        category_id  | 
      
        Long  | 
      
        Catalog ID  | 
     
| 
        level  | 
      
        String  | 
      
        Level. The value can be SUGGEST, MINOR, MAJOR, or FATAL.  | 
     
| 
        alarm_condition  | 
      
        String  | 
      
        Unified alarm condition  | 
     
| 
        alarm_notify  | 
      
        Boolean  | 
      
        Whether to enable alarm notifications  | 
     
| 
        alarm_notify_type  | 
      
        String  | 
      
        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 the execution is successful.  | 
     
| 
        alarm_notify_topic  | 
      
        String  | 
      
        Notification topic name  | 
     
| 
        schedule_type  | 
      
        String  | 
      
        Scheduling type. The value can be ONCE (one-time 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  | 
      
        Start time of the scheduling.  | 
     
| 
        schedule_end_time  | 
      
        String  | 
      
        End time of the scheduling  | 
     
| 
        create_time  | 
      
        Long  | 
      
        Creation time. The value is a 13-digit timestamp accurate to millisecond.  | 
     
| 
        last_run_time  | 
      
        Long  | 
      
        Last run 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-level rule; SingleTable indicates a table-level rule; SingleColumn indicates a field-level rule; CrossColumn indicates a cross-field rule; 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 name. Use commas (,) to separate multiple values.  | 
     
| 
        sql  | 
      
        String  | 
      
        SQL script in the custom rule  | 
     
| 
        tables  | 
      
        String  | 
      
        Table name. Use commas (,) to separate multiple values.  | 
     
| 
        reference_tables  | 
      
        String  | 
      
        Reference table name. Use commas (,) to separate multiple values.  | 
     
| 
        columns  | 
      
        String  | 
      
        Field name. Use commas (,) to separate multiple values.  | 
     
| 
        reference_columns  | 
      
        String  | 
      
        Reference column name. 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
None
Status Codes
| 
        Status Code  | 
      
        Description  | 
     
|---|---|
| 
        200  | 
      
        Response. If the operation 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.