更新时间:2024-04-28 GMT+08:00
分享

获取对账作业详情

功能介绍

获取对账作业详情

调用方法

请参见如何调用API

URI

GET /v2/{project_id}/quality/consistency-tasks/{id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

projectId

id

String

对账作业ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

workspace

String

workspace 信息

X-Auth-Token

String

token

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

id

Long

ID

name

String

作业名称

description

String

作业描述

category_id

Long

所属目录ID

level

String

SUGGEST:提示, MINOR:一般, MAJOR:严重, FATAL:致命

alarm_condition

String

统一告警条件

alarm_notify

Boolean

是否开启通知告警

alarm_notify_type

String

TRIGGER_ALARM:触发告警, RUN_SUCCESS:运行成功, TRIGGER_ALARM_AND_RUNNING_SUCCESS:触发告警和运行成功

alarm_notify_topic

String

通知主题名

schedule_type

String

调度类型,ONCE:单次调度,PERIODIC:周期性调度

schedule_period

String

调度周期,MINUTE:按分钟调度,HOUR:按小时调度,DAY:按天调度,WEEK:按周调度

schedule_interval

String

调度间隔,注意:当调度周期为分钟、小时、天时,间隔时间为数字;而当调度周期为周时,调度间隔为星期的英文,如:每周一、周二调度时,schedule_interval为"MONDAY,TUESDAY"

schedule_start_time

String

调度开始时间

schedule_end_time

String

调度结束时间

create_time

Long

最近运行时间,13位时间戳(精确到毫秒)

last_run_time

Long

最近运行时间,13位时间戳(精确到毫秒)

sub_rules

Array of ConsistencyRuleDetailForOpenApi objects

子规则

表4 ConsistencyRuleDetailForOpenApi

参数

参数类型

描述

id

Long

子规则ID

sub_rule_name

String

子规则名称

type

String

SingleDatabase:库级规则,SingleTable:表级规则,SingleColumn:字段级规则,CrossColumn:跨字段规则,Customize:自定义规则

template_id

Long

规则模板ID

connection

String

数据连接ID

connection_type

String

数据连接类型

databases

String

数据库名,当存在多个值时以逗号分隔

sql

String

自定义规则中的SQL脚本

tables

String

表名,当存在多个值时以逗号分隔

reference_tables

String

对照表名,当存在多个值时以逗号分隔

columns

String

字段名,当存在多个值时以逗号分隔

reference_columns

String

对照列名,当存在多个值时以逗号分隔

dimension

String

维度

queue

String

DLI队列

regular_expression

String

当规则模板为正则表达式校验时的正则表达式

template_arguments

String

模板参数

weight

Integer

规则权重

calculation_range

String

计算范围

calculation_range_sql

String

计算范围SQL

alarm_condition

String

告警表达式

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码,如DQC.0000,请求处理成功

error_msg

String

错误信息

状态码: 500

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码,如DQC.0000,请求处理成功

error_msg

String

错误信息

请求示例

响应示例

状态码: 200

Success 返回的是InstanceVO

{
  "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" : "DLI",
    "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" : "DLI",
    "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
  } ] ]
}

SDK代码示例

SDK代码示例如下。

 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 ShowConsistencyTaskDetailSolution {

    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();
        ShowConsistencyTaskDetailRequest request = new ShowConsistencyTaskDetailRequest();
        request.withId("{id}");
        try {
            ShowConsistencyTaskDetailResponse response = client.showConsistencyTaskDetail(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
# coding: utf-8

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 = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("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 = ShowConsistencyTaskDetailRequest()
        request.id = "{id}"
        response = client.show_consistency_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.ShowConsistencyTaskDetailRequest{}
	request.Id = "{id}"
	response, err := client.ShowConsistencyTaskDetail(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

Success 返回的是InstanceVO

400

BadRequest

500

INTERNAL SERVER ERROR

分享:

    相关文档

    相关产品