更新时间:2024-09-12 GMT+08:00
分享

获取规则模板列表

功能介绍

分页获取规则模板列表。

调用方法

请参见如何调用API

URI

GET /v2/{project_id}/quality/rule-templates

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方法请参见项目ID和账号ID

表2 Query参数

参数

是否必选

参数类型

描述

category_id

Long

目录ID。

name

String

规则模板名称。

system_template

Boolean

是否只查询系统模板。

creator

String

创建者。

limit

Integer

分页时每页的条数,最大值为100。

offset

Integer

分页偏移量。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

workspace

String

DataArts Studio工作空间ID,获取方法请参见实例ID和工作空间ID

X-Auth-Token

String

IAM Token,Token获取请参见认证鉴权

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

count

Long

总条数。

resources

Array of RuleTemplateDetailVO objects

分页数据。

表5 RuleTemplateDetailVO

参数

参数类型

描述

id

Long

规则模板ID。

name

String

规则模板名称。

category_id

Long

目录ID

dimension

String

维度,Completeness表示完整性,Uniqueness表示唯一性,Timeliness表示及时性,Validity表示有效性,Accuracy表示准确性,Consistency表示一致性。

type

String

规则类型,Field表示字段级规则,Table表示表级规则,Database表示库级规则,Cross-field表示跨字段级规则,Customize表示自定义规则。

system_template

Boolean

是否为系统模板。

sql_info

String

定义关系。

abnormal_table_template

String

异常表模板。

result_description

String

结果说明。

create_time

Long

创建时间,13位时间戳(精确到毫秒)。

creator

String

创建者,System代表系统自带。

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

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

error_msg

String

错误信息。

状态码: 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

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

error_msg

String

错误信息。

请求示例

响应示例

状态码: 200

Success

{
  "count" : 2,
  "resources" : [ {
    "id" : 1012384820829081600,
    "name" : "test",
    "dimension" : "Uniqueness",
    "sql_info" : "select count(*) from ${Schema_Table1}",
    "category_id" : 0,
    "type" : "Table",
    "system_template" : false,
    "create_time" : 1661412950486,
    "creator" : "ei",
    "result_description" : "row : ${1}"
  }, {
    "id" : 1,
    "name" : "表行数",
    "dimension" : "Accuracy",
    "sql_info" : "select count(1) from ${Schema_Table1}",
    "category_id" : 0,
    "type" : "Table",
    "system_template" : true,
    "create_time" : 1571328000000,
    "creator" : "System",
    "result_description" : "总行数 : ${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
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 ListQualityTemplatesSolution {

    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();
        ListQualityTemplatesRequest request = new ListQualityTemplatesRequest();
        try {
            ListQualityTemplatesResponse response = client.listQualityTemplates(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

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 = ListQualityTemplatesRequest()
        response = client.list_quality_templates(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
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.ListQualityTemplatesRequest{}
	response, err := client.ListQualityTemplates(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

Success

400

BadRequest

500

INTERNAL SERVER ERROR

相关文档