# 查询数据标准模板 - ShowStandardTemplate #### 功能介绍 查询当前工作空间下的数据标准模板。 #### 调用方法 请参见[如何调用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 GET /v2/{project_id}/design/standards/templates 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID，获取方法请参见[项目ID和账号ID](https://support.huaweicloud.com/api-dataartsstudio/projectid_accountid.html)。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | limit | 否 | Integer | 每页查询条数，即查询Y条数据。默认值50，取值范围\[1,100\]。 | | offset | 否 | Integer | 查询起始坐标，即跳过X条数据，仅支持0或limit的整数倍，不满足则向下取整，默认值0。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | IAM Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 使用Token认证时必选。 | | workspace | 是 | String | 工作空间ID，获取方法请参见[实例ID和工作空间ID](https://support.huaweicloud.com/api-dataartsstudio/dataartsstudio_02_0350.html)。 | | X-Project-Id | 否 | String | 项目ID，获取方法请参见[项目ID和账号ID](https://support.huaweicloud.com/api-dataartsstudio/projectid_accountid.html)。 多project场景采用AK/SK认证的接口请求，则该字段必选。 | | Content-Type | 否 | String | 默认值：application/json;charset=UTF-8 可选，有Body体的情况下必选，没有Body体则无需填写和校验。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | data | [data] object | 接口返回的数据。 | 表5data | 参数 | 参数类型 | 描述 | |:---|:---|:---| | value | [value] object | 查询数据标准模板结果 | 表6value | 参数 | 参数类型 | 描述 | |:---|:---|:---| | allFields | Array of [StandElementFieldVO] objects | 数据标准全部属性，集合中是单个StandElementFieldVO对象 | | optional | Array of [StandElementFieldVO] objects | 可选项,集合中是单个StandElementFieldVO对象 | | system_default | Array of [StandElementFieldVO] objects | 系统默认项，集合中是单个StandElementFieldVO对象 | | custom | Array of [StandElementFieldVO] objects | 自定义项,集合中是单个StandElementFieldVO对象 | | hasTemplate | Boolean | 是否使用模板 | 表7StandElementFieldVO | 参数 | 参数类型 | 描述 | |:---|:---|:---| | fd_name | String | 属性名称。 | | fd_name_en | String | 属性英文名称。 | | description | String | 属性描述。 | | descriptionEn | String | 属性英文描述。 | | label | String | 属性标签。 | | disabled | Boolean | 是否禁用。 | | id | String | 数据标准ID，ID字符串。 | | actived | Boolean | 是否显示，系统默认项必然显示不允许修改。true表示使用数据标准时体现（增改查的时候可以操作该属性），false表示使用数据标准时不体现。 | | required | Boolean | 是否必填。true：必填，false：非必填。 | | searchable | Boolean | 是否可搜索。true表示在数据标准列表页面可搜索，false表示在数据标准列表页面不可搜索。 | | optional_values | String | 允许值。 | | field_type | Integer | 字段类型，0表示系统字段， 1表示自定义字段。 | | displayed_name | String | 前端展示名。 | | displayed_name_en | String | 前端展示名英文。 | | create_time | String | 创建时间，只读，格式遵循RFC3339，精确到秒，UTC时区，即yyyy-mm-ddTHH:MM:SSZ，如1970-01-01T00:00:00Z。 | | update_time | String | 更新时间，只读，格式遵循RFC3339，精确到秒，UTC时区，即yyyy-mm-ddTHH:MM:SSZ，如1970-01-01T00:00:00Z。 | | create_by | String | 创建人。 | | update_by | String | 更新人。 | **状态码：400** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，如DS.6000，请求处理失败。 | | error_msg | String | 错误信息。 | | data | Object | 返回的数据信息。 | **状态码：401** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，如DS.6000，请求处理失败。 | | error_msg | String | 错误信息。 | | data | Object | 返回的数据信息。 | **状态码：403** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，如DS.6000，请求处理失败。 | | error_msg | String | 错误信息。 | | data | Object | 返回的数据信息。 | **状态码：404** 表11响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，如DS.6000，请求处理失败。 | | error_msg | String | 错误信息。 | | data | Object | 返回的数据信息。 | #### 请求示例 查询当前工作空间下的数据标准模板。 ``` GET https://{endpoint}/v2/{project_id}/design/standards/templates ``` #### 响应示例 **状态码：200** Success，返回data数据是StandElementFieldVO列表。 ``` { "data" : { "value" : { "allFields" : [ { "fd_name" : "nameCh", "fd_name_en" : null, "description" : "标准名称", "id" : "1020622096960831488", "actived" : true, "required" : true, "searchable" : true, "optional_values" : null, "field_type" : null, "displayed_name" : null, "displayed_name_en" : null, "create_time" : "2022-09-17T09:07:50+08:00", "update_time" : "2024-03-13T16:48:56+08:00", "create_by" : "test_user", "update_by" : "test_user" }, { "fd_name" : "nameEn", "fd_name_en" : null, "description" : "标准编码", "id" : "1020622096985997312", "actived" : true, "required" : true, "searchable" : true, "optional_values" : null, "field_type" : null, "displayed_name" : null, "displayed_name_en" : null, "create_time" : "2022-09-17T09:07:50+08:00", "update_time" : "2024-03-13T16:48:56+08:00", "create_by" : "test_user", "update_by" : "test_user" }, { "fd_name" : "dataType", "fd_name_en" : null, "description" : "数据类型", "id" : "1020622097006968832", "actived" : true, "required" : true, "searchable" : true, "optional_values" : null, "field_type" : null, "displayed_name" : null, "displayed_name_en" : null, "create_time" : "2022-09-17T09:07:50+08:00", "update_time" : "2024-03-13T16:48:56+08:00", "create_by" : "test_user", "update_by" : "test_user" }, { "fd_name" : "dataLength", "fd_name_en" : null, "description" : "数据长度", "id" : "1020622097032134656", "actived" : true, "required" : false, "searchable" : false, "optional_values" : null, "field_type" : null, "displayed_name" : null, "displayed_name_en" : null, "create_time" : "2022-09-17T09:07:50+08:00", "update_time" : "2024-03-13T16:48:56+08:00", "create_by" : "test_user", "update_by" : "test_user" }, { "fd_name" : "hasAllowValueList", "fd_name_en" : null, "description" : "是否有允许值", "id" : "1020622097048911872", "actived" : true, "required" : false, "searchable" : false, "optional_values" : null, "field_type" : null, "displayed_name" : null, "displayed_name_en" : null, "create_time" : "2022-09-17T09:07:50+08:00", "update_time" : "2024-03-13T16:48:56+08:00", "create_by" : "test_user", "update_by" : "test_user" }, { "fd_name" : "allowList", "fd_name_en" : null, "description" : "允许值", "id" : "1020622097065689088", "actived" : true, "required" : false, "searchable" : false, "optional_values" : null, "field_type" : null, "displayed_name" : null, "displayed_name_en" : null, "create_time" : "2022-09-17T09:07:50+08:00", "update_time" : "2024-03-13T16:48:56+08:00", "create_by" : "test_user", "update_by" : "test_user" }, { "fd_name" : "referCodeTable", "fd_name_en" : null, "description" : "引用码表", "id" : "1020622097086660608", "actived" : true, "required" : false, "searchable" : false, "optional_values" : null, "field_type" : null, "displayed_name" : null, "displayed_name_en" : null, "create_time" : "2022-09-17T09:07:50+08:00", "update_time" : "2024-03-13T16:48:56+08:00", "create_by" : "test_user", "update_by" : "test_user" }, { "fd_name" : "codeStandColumn", "fd_name_en" : null, "description" : "码表字段", "id" : "1020622097103437824", "actived" : true, "required" : false, "searchable" : false, "optional_values" : null, "field_type" : null, "displayed_name" : null, "displayed_name_en" : null, "create_time" : "2022-09-17T09:07:50+08:00", "update_time" : "2024-03-13T16:48:56+08:00", "create_by" : "test_user", "update_by" : "test_user" }, { "fd_name" : "dqcRule", "fd_name_en" : null, "description" : "质量规则", "id" : "1020622097124409344", "actived" : true, "required" : false, "searchable" : false, "optional_values" : null, "field_type" : null, "displayed_name" : null, "displayed_name_en" : null, "create_time" : "2022-09-17T09:07:50+08:00", "update_time" : "2024-03-13T16:48:56+08:00", "create_by" : "test_user", "update_by" : "test_user" }, { "fd_name" : "ruleOwner", "fd_name_en" : null, "description" : "业务规则责任人", "id" : "1020622097141186560", "actived" : true, "required" : false, "searchable" : false, "optional_values" : null, "field_type" : null, "displayed_name" : null, "displayed_name_en" : null, "create_time" : "2022-09-17T09:07:50+08:00", "update_time" : "2024-03-13T16:48:56+08:00", "create_by" : "test_user", "update_by" : "test_user" }, { "fd_name" : "dataMonitorOwner", "fd_name_en" : null, "description" : "数据监控责任人", "id" : "1020622097162158080", "actived" : true, "required" : false, "searchable" : false, "optional_values" : null, "field_type" : null, "displayed_name" : null, "displayed_name_en" : null, "create_time" : "2022-09-17T09:07:50+08:00", "update_time" : "2024-03-13T16:48:56+08:00", "create_by" : "test_user", "update_by" : "test_user" }, { "fd_name" : "standardLevel", "fd_name_en" : null, "description" : "标准层级", "id" : "1020622097178935296", "actived" : true, "required" : false, "searchable" : false, "optional_values" : null, "field_type" : null, "displayed_name" : null, "displayed_name_en" : null, "create_time" : "2022-09-17T09:07:50+08:00", "update_time" : "2024-03-13T16:48:56+08:00", "create_by" : "test_user", "update_by" : "test_user" }, { "fd_name" : "description", "fd_name_en" : null, "description" : "描述", "id" : "1020622097195712512", "actived" : true, "required" : false, "searchable" : false, "optional_values" : null, "field_type" : null, "displayed_name" : null, "displayed_name_en" : null, "create_time" : "2022-09-17T09:07:50+08:00", "update_time" : "2024-03-13T16:48:56+08:00", "create_by" : "test_user", "update_by" : "test_user" }, { "fd_name" : "englishName", "fd_name_en" : null, "description" : "英文名称", "id" : "1185628711836360704", "actived" : true, "required" : false, "searchable" : true, "optional_values" : null, "field_type" : null, "displayed_name" : null, "displayed_name_en" : null, "create_time" : "2023-12-16T17:05:13+08:00", "update_time" : "2024-03-13T16:48:56+08:00", "create_by" : "test_user", "update_by" : "test_user" } ], "custom" : [ ], "optional" : [ { "fd_name" : "dataLength", "fd_name_en" : null, "description" : "数据长度", "id" : "1020622097032134656", "actived" : true, "required" : false, "searchable" : false, "optional_values" : null, "field_type" : null, "displayed_name" : null, "displayed_name_en" : null, "create_time" : "2022-09-17T09:07:50+08:00", "update_time" : "2024-03-13T16:48:56+08:00", "create_by" : "test_user", "update_by" : "test_user" }, { "fd_name" : "hasAllowValueList", "fd_name_en" : null, "description" : "是否有允许值", "id" : "1020622097048911872", "actived" : true, "required" : false, "searchable" : false, "optional_values" : null, "field_type" : null, "displayed_name" : null, "displayed_name_en" : null, "create_time" : "2022-09-17T09:07:50+08:00", "update_time" : "2024-03-13T16:48:56+08:00", "create_by" : "test_user", "update_by" : "test_user" }, { "fd_name" : "allowList", "fd_name_en" : null, "description" : "允许值", "id" : "1020622097065689088", "actived" : true, "required" : false, "searchable" : false, "optional_values" : null, "field_type" : null, "displayed_name" : null, "displayed_name_en" : null, "create_time" : "2022-09-17T09:07:50+08:00", "update_time" : "2024-03-13T16:48:56+08:00", "create_by" : "test_user", "update_by" : "test_user" }, { "fd_name" : "referCodeTable", "fd_name_en" : null, "description" : "引用码表", "id" : "1020622097086660608", "actived" : true, "required" : false, "searchable" : false, "optional_values" : null, "field_type" : null, "displayed_name" : null, "displayed_name_en" : null, "create_time" : "2022-09-17T09:07:50+08:00", "update_time" : "2024-03-13T16:48:56+08:00", "create_by" : "test_user", "update_by" : "test_user" }, { "fd_name" : "codeStandColumn", "fd_name_en" : null, "description" : "码表字段", "id" : "1020622097103437824", "actived" : true, "required" : false, "searchable" : false, "optional_values" : null, "field_type" : null, "displayed_name" : null, "displayed_name_en" : null, "create_time" : "2022-09-17T09:07:50+08:00", "update_time" : "2024-03-13T16:48:56+08:00", "create_by" : "test_user", "update_by" : "test_user" }, { "fd_name" : "dqcRule", "fd_name_en" : null, "description" : "质量规则", "id" : "1020622097124409344", "actived" : true, "required" : false, "searchable" : false, "optional_values" : null, "field_type" : null, "displayed_name" : null, "displayed_name_en" : null, "create_time" : "2022-09-17T09:07:50+08:00", "update_time" : "2024-03-13T16:48:56+08:00", "create_by" : "test_user", "update_by" : "test_user" }, { "fd_name" : "ruleOwner", "fd_name_en" : null, "description" : "业务规则责任人", "id" : "1020622097141186560", "actived" : true, "required" : false, "searchable" : false, "optional_values" : null, "field_type" : null, "displayed_name" : null, "displayed_name_en" : null, "create_time" : "2022-09-17T09:07:50+08:00", "update_time" : "2024-03-13T16:48:56+08:00", "create_by" : "test_user", "update_by" : "test_user" }, { "fd_name" : "dataMonitorOwner", "fd_name_en" : null, "description" : "数据监控责任人", "id" : "1020622097162158080", "actived" : true, "required" : false, "searchable" : false, "optional_values" : null, "field_type" : null, "displayed_name" : null, "displayed_name_en" : null, "create_time" : "2022-09-17T09:07:50+08:00", "update_time" : "2024-03-13T16:48:56+08:00", "create_by" : "test_user", "update_by" : "test_user" }, { "fd_name" : "standardLevel", "fd_name_en" : null, "description" : "标准层级", "id" : "1020622097178935296", "actived" : true, "required" : false, "searchable" : false, "optional_values" : null, "field_type" : null, "displayed_name" : null, "displayed_name_en" : null, "create_time" : "2022-09-17T09:07:50+08:00", "update_time" : "2024-03-13T16:48:56+08:00", "create_by" : "test_user", "update_by" : "test_user" }, { "fd_name" : "description", "fd_name_en" : null, "description" : "描述", "id" : "1020622097195712512", "actived" : true, "required" : false, "searchable" : false, "optional_values" : null, "field_type" : null, "displayed_name" : null, "displayed_name_en" : null, "create_time" : "2022-09-17T09:07:50+08:00", "update_time" : "2024-03-13T16:48:56+08:00", "create_by" : "test_user", "update_by" : "test_user" }, { "fd_name" : "englishName", "fd_name_en" : null, "description" : "英文名称", "id" : "1185628711836360704", "actived" : true, "required" : false, "searchable" : true, "optional_values" : null, "field_type" : null, "displayed_name" : null, "displayed_name_en" : null, "create_time" : "2023-12-16T17:05:13+08:00", "update_time" : "2024-03-13T16:48:56+08:00", "create_by" : "test_user", "update_by" : "test_user" } ], "hasTemplate" : true, "system_default" : [ { "fd_name" : "nameCh", "fd_name_en" : null, "description" : "标准名称", "id" : "1020622096960831488", "actived" : true, "required" : true, "searchable" : true, "optional_values" : null, "field_type" : null, "displayed_name" : null, "displayed_name_en" : null, "create_time" : "2022-09-17T09:07:50+08:00", "update_time" : "2024-03-13T16:48:56+08:00", "create_by" : "test_user", "update_by" : "test_user" }, { "fd_name" : "nameEn", "fd_name_en" : null, "description" : "标准编码", "id" : "1020622096985997312", "actived" : true, "required" : true, "searchable" : true, "optional_values" : null, "field_type" : null, "displayed_name" : null, "displayed_name_en" : null, "create_time" : "2022-09-17T09:07:50+08:00", "update_time" : "2024-03-13T16:48:56+08:00", "create_by" : "test_user", "update_by" : "test_user" }, { "fd_name" : "dataType", "fd_name_en" : null, "description" : "数据类型", "id" : "1020622097006968832", "actived" : true, "required" : true, "searchable" : true, "optional_values" : null, "field_type" : null, "displayed_name" : null, "displayed_name_en" : null, "create_time" : "2022-09-17T09:07:50+08:00", "update_time" : "2024-03-13T16:48:56+08:00", "create_by" : "test_user", "update_by" : "test_user" } ] } } } ``` **状态码：400** BadRequest ``` { "error_code" : "DS.60xx", "error_msg" : "The user request is illegal." } ``` **状态码：401** Unauthorized ``` { "error_code" : "DS.60xx", "error_msg" : "User authentication failed." } ``` **状态码：403** Forbidden ``` { "error_code" : "DS.60xx", "error_msg" : "The user does not have permission to call this API." } ``` **状态码：404** Not Found ``` { "error_code" : "DS.60xx", "error_msg" : "The User Request API does not exist." } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] ``` 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 ShowStandardTemplateSolution { 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(); ShowStandardTemplateRequest request = new ShowStandardTemplateRequest(); try { ShowStandardTemplateResponse response = client.showStandardTemplate(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] ``` # 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 = ShowStandardTemplateRequest() response = client.show_standard_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] ``` 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.ShowStandardTemplateRequest{} response, err := client.ShowStandardTemplate(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=ShowStandardTemplate)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | Success，返回data数据是StandElementFieldVO列表。 | | 400 | BadRequest | | 401 | Unauthorized | | 403 | Forbidden | | 404 | Not Found |