# 创建规则模板 - CreateTemplate #### 功能介绍 创建规则模板。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-dataartsstudio/making_request.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dataartsstudio/abcd.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI POST /v2/{project_id}/quality/rule-templates 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID，获取方法请参见[项目ID和账号ID](https://support.huaweicloud.com/api-dataartsstudio/projectid_accountid.html)。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | workspace | 是 | String | DataArts Studio工作空间ID，获取方法请参见[实例ID和工作空间ID](https://support.huaweicloud.com/api-dataartsstudio/dataartsstudio_02_0350.html)。 | | X-Auth-Token | 是 | String | IAM Token，Token获取请参见[认证鉴权](https://support.huaweicloud.com/api-dataartsstudio/dataartsstudio_02_0010.html)。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | id | 否 | String | 规则模板ID。 | | name | 否 | String | 规则模板名称。 | | 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** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，如DQC.0000表示请求处理成功。 | | error_msg | String | 错误信息。 | **状态码：500** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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代码示例如下。 - [Java] 创建一个规则模板名称为test的规则模板，模板id为0，目录id为0，维度id为1，模板中的sql内容为select count(\*) from ${Schema_Table1}，发布操作默认为false，结果说明为总条数，描述为test。 ``` 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("")) .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()); } } } ``` - [Python] 创建一个规则模板名称为test的规则模板，模板id为0，目录id为0，维度id为1，模板中的sql内容为select count(\*) from ${Schema_Table1}，发布操作默认为false，结果说明为总条数，描述为test。 ``` # 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("")) \ .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) ``` - [Go] 创建一个规则模板名称为test的规则模板，模板id为0，目录id为0，维度id为1，模板中的sql内容为select count(\*) from ${Schema_Table1}，发布操作默认为false，结果说明为总条数，描述为test。 ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := dataartsstudio.DataArtsStudioClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := dataartsstudio.NewDataArtsStudioClient(hcClient) 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](https://console.huaweicloud.com/apiexplorer/#/openapi/DataArtsStudio/sdk?api=CreateTemplate)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | Success | | 400 | BadRequest | | 500 | INTERNAL SERVER ERROR |