# 标准覆盖率统计信息 - CountStandards #### 功能介绍 查看某个数据标准在所有模型字段中的覆盖率，即使用该标准的字段占总字段的百分比。 #### 调用方法 请参见[如何调用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/definitions/statistic/{id} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID，获取方法请参见[项目ID和账号ID](https://support.huaweicloud.com/api-dataartsstudio/projectid_accountid.html)。 | | id | 是 | String | 实体ID，ID字符串。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | biz_type | 否 | String | 按业务类型查询，可选业务类型有：ATOMIC_INDEX（原子指标）、DERIVATIVE_INDEX（衍生指标）、DIMENSION（维度）、TIME_CONDITION（时间限定）、DIMENSION_LOGIC_TABLE（维度表）、FACT_LOGIC_TABLE（事实表）、AGGREGATION_LOGIC_TABLE（汇总表）、TABLE_MODEL（关系建模表）、CODE_TABLE（码表）、STANDARD_ELEMENT（数据标准）、BIZ_METRIC（业务指标）、COMPOUND_METRIC（复合指标）、SUBJECT（主题）、ATOMIC_METRIC（原子指标（新））、DERIVED_METRIC（衍生指标（新））、COMPOSITE_METRIC（复合指标（新））。 | #### 请求参数 表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 | data，统一的返回结果的最外层数据结构。 | 表5data | 参数 | 参数类型 | 描述 | |:---|:---|:---| | value | [StatisticStandardCoverageVO] object | value，统一的返回结果的外层数据结构。 | 表6StatisticStandardCoverageVO | 参数 | 参数类型 | 描述 | |:---|:---|:---| | all_col_num | String | 字段总数，ID字符串。 | | col_num | String | 关联标准字段数，ID字符串。 | | coverage | Double | 标准覆盖率。 | | details | Array of [AllTableVO] objects | 引用表数组。 | 表7AllTableVO | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | l1的ID，ID字符串。 | | name | String | l1名称。 | | tb_logic_guid | String | 表发布后对应的逻辑实体guid。 | | quality_id | String | 质量ID。 | | quality_id_extend | String | 质量id，扩展字段。 | | reversed | Boolean | 是否是逆向的。 | | partition_conf | String | 分区表达式。 | | dirty_out_switch | Boolean | 异常数据输出开关。 | | dirty_out_database | String | 异常数据输出库。 | | dirty_out_prefix | String | 异常表前缀。 | | dirty_out_suffix | String | 异常表后缀。 | | tb_guid | String | 表发布后对应的物理表guid。 | | code | String | 编码。 | | create_by | String | 创建人。 | | tenant_id | String | 租户ID。 | | description | String | 描述。 | | status | String | 实体的发布状态，只读，创建和更新时无需填写。 枚举值： - DRAFT: 草稿 - PUBLISH_DEVELOPING: 发布待审核 - PUBLISHED: 已发布 - OFFLINE_DEVELOPING: 下线待审核 - OFFLINE: 已下线 - REJECT: 已驳回 | | biz_type | String | 业务实体类型。 枚举值： - AGGREGATION_LOGIC_TABLE: 汇总表 - ATOMIC_INDEX: 原子指标 - ATOMIC_METRIC: 原子指标（新） - BIZ_CATALOG: 流程架构目录 - BIZ_METRIC: 业务指标 - CODE_TABLE: 码表 - COMMON_CONDITION: 通用限定 - COMPOSITE_METRIC: 复合指标（新） - COMPOUND_METRIC: 复合指标 - CONDITION_GROUP: 限定分组 - DEGENERATE_DIMENSION: 退化维度 - DERIVATIVE_INDEX: 衍生指标 - DERIVED_METRIC: 衍生指标（新） - DIMENSION: 维度 - DIMENSION_ATTRIBUTE: 维度属性 - DIMENSION_HIERARCHIES: 维度层级 - DIMENSION_LOGIC_TABLE: 维度表 - DIMENSION_TABLE_ATTRIBUTE: 维度属性 - DIRECTORY: 目录 - FACT_ATTRIBUTE: 事实表属性 - FACT_DIMENSION: 事实表维度 - FACT_LOGIC_TABLE: 事实表 - FACT_MEASURE: 事实表度量 - FUNCTION: 函数 - INFO_ARCH: 信息架构（批量修改主题使用） - MODEL: 模型 - QUALITY_RULE: 质量规则 - SECRECY_LEVEL: 密级 - STANDARD_ELEMENT: 数据标准 - STANDARD_ELEMENT_TEMPLATE: 数据标准模板 - SUBJECT: 主题 - SUMMARY_DIMENSION_ATTRIBUTE: 汇总表维度属性 - SUMMARY_INDEX: 汇总表指标属性 - SUMMARY_TIME: 汇总表时间周期属性 - TABLE_MODEL: 关系模型（逻辑模型/物理模型） - TABLE_MODEL_ATTRIBUTE: 关系模型属性（逻辑模型/物理模型） - TABLE_MODEL_LOGIC: 逻辑实体 - TABLE_TYPE: 表类型 - TAG: 标签 - TIME_CONDITION: 时间限定 | | 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。 | | db_name | String | 数据库名。 | | dw_type | String | 数据连接类型，对应表所在的数仓类型，取值可以为DWS、MRS_HIVE、POSTGRESQL、MRS_SPARK、CLICKHOUSE、MYSQL、ORACLE和DORIS等。 | | queue_name | String | dli数据连接执行sql所需的队列，数据连接类型为DLI时必须。 | | schema | String | DWS类型需要。 | | l1 | String | 主题域分组。 | | l2 | String | 主题域。 | | l3 | String | 业务对象。 | | l1_id | String | 主题域分组ID，只读，ID字符串。 | | l2_id | String | 主题域ID。 | | l3_id | String | 业务对象ID，只读，ID字符串。 | | new_biz | [BizVersionManageVO] object | 业务版本管理，只读。 | | physical_table | String | 生产环境创建表状态 | | dev_physical_table | String | 开发环境创建表状态 | | technical_asset | String | 技术资产同步状态，只读。 | | business_asset | String | 业务资产同步状态，只读。 | | meta_data_link | String | 资产关联状态，只读。 | | data_quality | String | 质量作业状态，只读。 | | dlf_task | String | 数据开发作业状态，只读。 | | materialization | String | 码表数值落库状态，只读。 | | publish_to_dlm | String | DLM API生成状态，只读。 | | summary_status | String | 同步整体状态，只读。 | | standard_count | String | 标准数量，只读，ID字符串。 | | alias | String | 别名。 | | api_id | String | 汇总表API ID。 | | dlf_task_id | String | DLF 作业 ID。 | | workspace_id | String | 工作空间ID。 | | workspace_name | String | 工作空间名称。 | | dev_version | String | 开发环境版本，只读，ID字符串。 | | prod_version | String | 生产环境版本，只读，ID字符串。 | | dev_version_name | String | 开发环境版本名称，只读。 | | prod_version_name | String | 生产环境版本名称，只读。 | | env_type | String | 开发生产环境类型。 枚举值： - INVALID_TYPE: 无效环境 - DEV_TYPE: 开发环境 - PROD_TYPE: 生产环境 - DEV_PROD_TYPE: 开发生产环境 | 表8BizVersionManageVO | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | ID信息，ID字符串。 | | biz_type | String | 业务实体类型。 枚举值： - AGGREGATION_LOGIC_TABLE: 汇总表 - ATOMIC_INDEX: 原子指标 - ATOMIC_METRIC: 原子指标（新） - BIZ_CATALOG: 流程架构目录 - BIZ_METRIC: 业务指标 - CODE_TABLE: 码表 - COMMON_CONDITION: 通用限定 - COMPOSITE_METRIC: 复合指标（新） - COMPOUND_METRIC: 复合指标 - CONDITION_GROUP: 限定分组 - DEGENERATE_DIMENSION: 退化维度 - DERIVATIVE_INDEX: 衍生指标 - DERIVED_METRIC: 衍生指标（新） - DIMENSION: 维度 - DIMENSION_ATTRIBUTE: 维度属性 - DIMENSION_HIERARCHIES: 维度层级 - DIMENSION_LOGIC_TABLE: 维度表 - DIMENSION_TABLE_ATTRIBUTE: 维度属性 - DIRECTORY: 目录 - FACT_ATTRIBUTE: 事实表属性 - FACT_DIMENSION: 事实表维度 - FACT_LOGIC_TABLE: 事实表 - FACT_MEASURE: 事实表度量 - FUNCTION: 函数 - INFO_ARCH: 信息架构（批量修改主题使用） - MODEL: 模型 - QUALITY_RULE: 质量规则 - SECRECY_LEVEL: 密级 - STANDARD_ELEMENT: 数据标准 - STANDARD_ELEMENT_TEMPLATE: 数据标准模板 - SUBJECT: 主题 - SUMMARY_DIMENSION_ATTRIBUTE: 汇总表维度属性 - SUMMARY_INDEX: 汇总表指标属性 - SUMMARY_TIME: 汇总表时间周期属性 - TABLE_MODEL: 关系模型（逻辑模型/物理模型） - TABLE_MODEL_ATTRIBUTE: 关系模型属性（逻辑模型/物理模型） - TABLE_MODEL_LOGIC: 逻辑实体 - TABLE_TYPE: 表类型 - TAG: 标签 - TIME_CONDITION: 时间限定 | | biz_id | String | 业务ID，ID字符串。 | | biz_info | String | 业务对象信息。 | | status | String | 实体的发布状态，只读，创建和更新时无需填写。 枚举值： - DRAFT: 草稿 - PUBLISH_DEVELOPING: 发布待审核 - PUBLISHED: 已发布 - OFFLINE_DEVELOPING: 下线待审核 - OFFLINE: 已下线 - REJECT: 已驳回 | | biz_version | Integer | 业务版本，只读。 | | 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。 | **状态码：400** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，如DS.6000，请求处理失败。 | | error_msg | String | 错误信息。 | | data | Object | 返回的数据信息。 | **状态码：401** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，如DS.6000，请求处理失败。 | | error_msg | String | 错误信息。 | | data | Object | 返回的数据信息。 | **状态码：403** 表11响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，如DS.6000，请求处理失败。 | | error_msg | String | 错误信息。 | | data | Object | 返回的数据信息。 | #### 请求示例 查看ID为1186622399320305665的数据标准的表属性覆盖率。 ``` GET https://{endpoint}/v2/{project_id}/design/definitions/statistic/1186622399320305665?biz_type=STANDARD_ELEMENT ``` #### 响应示例 **状态码：200** Success，返回data数据是StatisticStandardCoverageVO信息。 ``` { "data" : { "value" : { "all_col_num" : "621", "col_num" : "1", "coverage" : 0.001610305958132045, "details" : [ { "id" : "1202300665725100032", "name" : "test_czh_secrecy_0055", "tb_logic_guid" : "163b03fa-44c8-4eb1-9844-fdec203325b0", "quality_id" : null, "reversed" : null, "partition_conf" : null, "dirty_out_switch" : false, "dirty_out_database" : "", "dirty_out_prefix" : "", "dirty_out_suffix" : "", "tb_guid" : null, "code" : "test_czh_secrecy_005", "create_by" : "test_user", "tenant_id" : "0833a5737480d53b2f25c010dc1a7b88-workspace-9ce2cfd08fda4f3b95faa5ba65fa5ec3", "description" : "无", "status" : "PUBLISHED", "biz_type" : "TABLE_MODEL", "create_time" : "2024-01-31T17:13:36+08:00", "update_time" : "2024-04-08T15:50:39+08:00", "db_name" : null, "dw_type" : "DWS", "queue_name" : null, "schema" : null, "l1" : null, "l2" : null, "l3" : null, "l1_id" : null, "l2_id" : null, "l3_id" : "1194966710038474752", "new_biz" : null, "physical_table" : "UPDATE_FAILED", "dev_physical_table" : "NO_NEED", "technical_asset" : "CREATE_FAILED", "business_asset" : "NO_NEED", "meta_data_link" : "UPDATE_FAILED", "data_quality" : "NO_NEED", "dlf_task" : "NO_NEED", "materialization" : null, "publish_to_dlm" : null, "summary_status" : "SUMMARY_FAILED", "standard_count" : "1", "alias" : null, "api_id" : "0", "workspace_id" : "9ce2cfd08fda4f3b95faa5ba65fa5ec3", "workspace_name" : "test_czh_simple", "dev_version" : null, "prod_version" : "1202300758293389312", "dev_version_name" : null, "prod_version_name" : null, "env_type" : "PROD_TYPE" } ] } } } ``` **状态码：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." } ``` #### 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 CountStandardsSolution { 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(); CountStandardsRequest request = new CountStandardsRequest(); request.withId("{id}"); try { CountStandardsResponse response = client.countStandards(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 = CountStandardsRequest() request.id = "{id}" response = client.count_standards(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.CountStandardsRequest{} request.Id = "{id}" response, err := client.CountStandards(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=CountStandards)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | Success，返回data数据是StatisticStandardCoverageVO信息。 | | 400 | BadRequest | | 401 | Unauthorized | | 403 | Forbidden |