创建规则模板
功能介绍
创建规则模板
调用方法
请参见如何调用API。
URI
POST /v2/{project_id}/quality/rule-templates
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
project id |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
workspace |
是 |
String |
workspace 信息 |
X-Auth-Token |
是 |
String |
token |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
id |
否 |
String |
template id |
name |
否 |
String |
template name |
directory_id |
否 |
Long |
目录 |
dimension_id |
否 |
Integer |
维度ID, 1:完整性,2:唯一性,3:及时性,4:有效性,5:准确性,6:一致性 |
description |
否 |
String |
描述 |
sql_info |
否 |
String |
模板中的sql内容 |
result_description |
否 |
String |
结果说明 |
publish |
否 |
Boolean |
是否是发布操作, true:发布新版本 false:普通的保存操作 |
origin_name |
否 |
String |
修改前的模板名 |
abnormal_table_template |
否 |
String |
异常表模板 |
user_define_version_name |
否 |
String |
用户自定义版本名 |
version_num |
否 |
Long |
获取模板信息时候的版本号 |
status |
否 |
Integer |
规则模板状态,0表示下线1表示已发布 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
id |
Long |
id |
name |
String |
name |
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
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码,如DQC.0000,请求处理成功 |
error_msg |
String |
错误信息 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码,如DQC.0000,请求处理成功 |
error_msg |
String |
错误信息 |
请求示例
创建一个规则模板名称为test的规则模板,模板id为0,目录id为0,纬度id为1,模板中的sql内容为select count(*) from ${Schema_Table1},发布操作默认为false,结果说明为总条数,描述为test。
POST /v2/0833a5737480d53b2f25c010dc1a7b88/quality/rule-templates { "id" : "0", "name" : "test", "directory_id" : "0", "dimension_id" : 1, "description" : "test", "sql_info" : "select count(*) from ${Schema_Table1}", "result_description" : "总条数", "publish" : false, "origin_name" : null, "abnormal_table_template" : "select count(*) from ${Schema_Table1}", "user_define_version_name" : null, "version_num" : null, "status" : null }
响应示例
状态码: 200
Success
{ "id" : "1045431715138617345", "name" : "test", "category_id" : 0, "dimension" : "Completeness", "type" : "Table", "system_template" : false, "sql_info" : "select count(*) from ${Schema_Table1}", "abnormal_table_template" : "select count(*) from ${Schema_Table1}", "result_description" : "总条数", "create_time" : 1640678720014, "creator" : "test" }
SDK代码示例
SDK代码示例如下。
创建一个规则模板名称为test的规则模板,模板id为0,目录id为0,纬度id为1,模板中的sql内容为select count(*) from ${Schema_Table1},发布操作默认为false,结果说明为总条数,描述为test。
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 49 50 51 52 53 54 55 56 57 58 |
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 CreateTemplateSolution { 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(); CreateTemplateRequest request = new CreateTemplateRequest(); TemplateRO body = new TemplateRO(); body.withAbnormalTableTemplate("select count(*) from ${Schema_Table1}"); body.withPublish(false); body.withResultDescription("总条数"); body.withSqlInfo("select count(*) from ${Schema_Table1}"); body.withDescription("test"); body.withDimensionId(1); body.withDirectoryId(0L); body.withName("test"); body.withId("0"); request.withBody(body); try { CreateTemplateResponse response = client.createTemplate(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()); } } } |
创建一个规则模板名称为test的规则模板,模板id为0,目录id为0,纬度id为1,模板中的sql内容为select count(*) from ${Schema_Table1},发布操作默认为false,结果说明为总条数,描述为test。
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 |
# 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 = CreateTemplateRequest() request.body = TemplateRO( abnormal_table_template="select count(*) from ${Schema_Table1}", publish=False, result_description="总条数", sql_info="select count(*) from ${Schema_Table1}", description="test", dimension_id=1, directory_id=0, name="test", id="0" ) response = client.create_template(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
创建一个规则模板名称为test的规则模板,模板id为0,目录id为0,纬度id为1,模板中的sql内容为select count(*) from ${Schema_Table1},发布操作默认为false,结果说明为总条数,描述为test。
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 49 50 51 52 53 54 55 56 57 |
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.CreateTemplateRequest{} abnormalTableTemplateTemplateRo:= "select count(*) from ${Schema_Table1}" publishTemplateRo:= false resultDescriptionTemplateRo:= "总条数" sqlInfoTemplateRo:= "select count(*) from ${Schema_Table1}" descriptionTemplateRo:= "test" dimensionIdTemplateRo:= int32(1) directoryIdTemplateRo:= int64(0) nameTemplateRo:= "test" idTemplateRo:= "0" request.Body = &model.TemplateRo{ AbnormalTableTemplate: &abnormalTableTemplateTemplateRo, Publish: &publishTemplateRo, ResultDescription: &resultDescriptionTemplateRo, SqlInfo: &sqlInfoTemplateRo, Description: &descriptionTemplateRo, DimensionId: &dimensionIdTemplateRo, DirectoryId: &directoryIdTemplateRo, Name: &nameTemplateRo, Id: &idTemplateRo, } response, err := client.CreateTemplate(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 |