Obtaining Quality Job Details
Function
This API is used to obtain the details of a quality job.
Calling Method
For details, see Calling APIs.
URI
GET /v2/{project_id}/quality/quality-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 |
Quality 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 |
Directory 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_start_date |
String |
Scheduling start date |
schedule_end_date |
String |
Scheduling end date |
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 QualityTaskRuleDetailForOpenApi objects |
Sub-rules |
schedule_cron |
String |
Scheduling cron expression |
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 a custom rule, which is returned for a system rule |
tables |
String |
Table names. Use commas (,) to separate multiple values. |
reference_tables |
String |
Reference table names in a cross-field rule. Use commas (,) to separate multiple values. |
columns |
String |
Field names. Use commas (,) to separate multiple values. |
reference_columns |
String |
Reference field names in a cross-field rule. Use commas (,) to separate multiple values. |
ignore_error |
Boolean |
Whether to ignore rule errors |
dimension |
String |
Dimension, which can be Completeness, Uniqueness, Timeliness, Validity, Accuracy, or Consistency |
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 |
export_abnormal_table |
Boolean |
Whether to export abnormal data |
abnormal_table_database |
String |
Database where the abnormal table is located |
abnormal_table_schema |
String |
Abnormal table schema |
abnormal_table |
String |
Table where abnormal fields are located |
abnormal_table_prefix |
String |
Abnormal table prefix |
abnormal_table_suffix |
String |
Abnormal table suffix |
abnormal_table_columns |
String |
Names of abnormal fields. Use commas (,) to separate multiple values. |
abnormal_table_sql |
String |
Abnormal table SQL |
abnormal_table_out_config |
Boolean |
Whether the abnormal table outputs rule configuration |
abnormal_table_include_null_value |
Boolean |
Whether the abnormal table contains null values |
abnormal_table_out_data_number |
Integer |
Number of rows output from the abnormal table. Value 0 indicates that all rows are output. |
score_switch |
Boolean |
Whether to enable quality scoring |
score_schema |
String |
Schema where the quality scoring table is located |
score_table |
String |
Name of the quality scoring table |
score_expression |
String |
Quality scoring 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" : 1012385458115825700, "name" : "test", "description" : "", "level" : "SUGGEST", "alarm_condition" : "", "alarm_notify" : false, "alarm_notify_type" : null, "alarm_notify_topic" : "", "schedule_type" : "ONCE", "schedule_start_date" : null, "schedule_end_date" : null, "schedule_period" : null, "schedule_interval" : null, "schedule_start_time" : null, "schedule_end_time" : null, "category_id" : 1012384968858652700, "create_time" : 1661413102000, "last_run_time" : 1661413281000, "sub_rules" : [ { "id" : 1012385458417815600, "sub_rule_name" : "qwe", "type" : "SingleTable", "connection" : "43b9e6315eda4918970cfcbbbfb74cb1", "connection_type" : "DWS", "databases" : "1_database", "sql" : "select count(1) from 1_database.dqc_test2 where 1=1", "tables" : "1_database.dqc_test2", "reference_tables" : null, "columns" : "", "reference_columns" : null, "ignore_error" : false, "dimension" : "Accuracy", "queue" : "dlf_notdelete", "regular_expression" : null, "template_arguments" : "", "weight" : 5, "calculation_range" : "FULL_SCAN", "calculation_range_sql" : null, "alarm_condition" : "${1}<0", "export_abnormal_table" : false, "abnormal_table_database" : null, "abnormal_table_schema" : null, "abnormal_table" : "", "abnormal_table_prefix" : null, "abnormal_table_suffix" : null, "abnormal_table_columns" : null, "abnormal_table_sql" : "", "abnormal_table_out_config" : false, "abnormal_table_include_null_value" : false, "abnormal_table_out_data_number" : 0, "score_switch" : false, "score_schema" : null, "score_table" : null, "score_expression" : "", "template_id" : 1 } ], "schedule_cron" : "" }
SDK Sample Code
The SDK sample code is as follows.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.dataartsstudio.v1.region.DataArtsStudioRegion; import com.huaweicloud.sdk.dataartsstudio.v1.*; import com.huaweicloud.sdk.dataartsstudio.v1.model.*; public class ShowQualityTaskDetailSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); DataArtsStudioClient client = DataArtsStudioClient.newBuilder() .withCredential(auth) .withRegion(DataArtsStudioRegion.valueOf("<YOUR REGION>")) .build(); ShowQualityTaskDetailRequest request = new ShowQualityTaskDetailRequest(); request.withId("{id}"); try { ShowQualityTaskDetailResponse response = client.showQualityTaskDetail(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkdataartsstudio.v1.region.dataartsstudio_region import DataArtsStudioRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdataartsstudio.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = DataArtsStudioClient.new_builder() \ .with_credentials(credentials) \ .with_region(DataArtsStudioRegion.value_of("<YOUR REGION>")) \ .build() try: request = ShowQualityTaskDetailRequest() request.id = "{id}" response = client.show_quality_task_detail(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" dataartsstudio "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := dataartsstudio.NewDataArtsStudioClient( dataartsstudio.DataArtsStudioClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ShowQualityTaskDetailRequest{} request.Id = "{id}" response, err := client.ShowQualityTaskDetail(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
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.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot