文档首页/ 数据治理中心 DataArts Studio/ API参考/ 数据架构API/ 概览/ 关系建模统计信息

更新时间：2024-11-14 GMT+08:00

在线调试

CLI示例

查看PDF

关系建模统计信息

功能介绍

关系建模页面，外层的统计信息。

调用方法

请参见如何调用API。

URI

GET /v2/{project_id}/design/models/statistic

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID，获取方法请参见项目ID和账号ID。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	IAM Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）使用Token认证时必选。
workspace	是	String	工作空间ID，获取方法请参见实例ID和工作空间ID。
X-Project-Id	否	String	项目ID，获取方法请参见项目ID和账号ID。多project场景采用AK/SK认证的接口请求，则该字段必选。
Content-Type	否	String	默认值：application/json;charset=UTF-8 可选，有Body体的情况下必选，没有Body体则无需填写和校验。

响应参数

状态码： 200

表3 响应Body参数
参数	参数类型	描述
data	data object	data，统一的返回结果的最外层数据结构。

表4 data
参数	参数类型	描述
value	AllModelStatisticVO object	value，统一的返回结果的外层数据结构。

表5 AllModelStatisticVO
参数	参数类型	描述
frequent	Array of ModelStatisticVO objects	是否为常用。
top	Array of ModelStatisticVO objects	首层模型。
logic	Array of ModelStatisticVO objects	逻辑模型。
physical	Array of ModelStatisticVO objects	物理模型。
dwr	ModelStatisticVO object	DWR数据报告层。
dm	ModelStatisticVO object	DM数据整合层。

表6 ModelStatisticVO
参数	参数类型	描述
biz_type	String	业务类型。
level	String	模型层级。
db	Integer	数据库。
tb	Integer	数据表。
tb_published	Integer	已发布的数据表。
fd	Integer	字段。
fd_published	Integer	已发布的字段。
st	Double	标准覆盖率。
st_published	Double	已发布的标准覆盖率。
model	WorkspaceVO object	模型信息。

表7 WorkspaceVO
参数	参数类型	描述
id	String	编号，ID字符串。
name	String	工作区名字。
description	String	描述。
is_physical	Boolean	是否为物理表。
frequent	Boolean	是否为常用。
top	Boolean	分层治理。
level	String	数据治理分层。枚举值： SDI: 贴源数据层 DWI: 数据整合层 DWR: 数据报告层 DM: 数据集市层
dw_type	String	数据连接类型，对应表所在的数仓类型，取值可以为DWS、MRS_HIVE、POSTGRESQL、MRS_SPARK、CLICKHOUSE、MYSQL、ORACLE和DORIS等。
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	更新人。
type	String	工作区类型枚举。枚举值： THIRD_NF: 关系建模 DIMENSION: 维度建模
biz_catalog_ids	String	关联的业务分层的ID列表 {"l1Ids":[],"l2Ids":[],"l3Ids":[]}。
databases	Array of strings	数据库名称数组。
table_model_prefix	String	模型校验前缀，长度不超过100，数字字母下划线组成，字母开头

状态码： 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	返回的数据信息。

请求示例

关系建模统计信息。

GET https://{endpoint}/v2/{project_id}/design/models/statistic

响应示例

状态码： 200

Success，返回data数据是AllModelStatisticVO信息。

{
  "data" : {
    "value" : {
      "frequent" : null,
      "top" : [ {
        "biz_type" : "TABLE_MODEL",
        "level" : "SDI",
        "db" : 2,
        "tb" : 14,
        "tb_published" : 10,
        "fd" : 31,
        "fd_published" : 20,
        "st" : 0.06451612903225806,
        "st_published" : 0.1,
        "model" : {
          "id" : "1183882892003127296",
          "name" : "test_prefix_001",
          "description" : "",
          "is_physical" : true,
          "frequent" : false,
          "top" : true,
          "level" : "SDI",
          "dw_type" : "DWS",
          "create_time" : "2023-12-11T21:27:57+08:00",
          "update_time" : "2024-04-08T19:18:05+08:00",
          "create_by" : "test_uesr",
          "update_by" : "test_uesr",
          "type" : "THIRD_NF",
          "biz_catalog_ids" : null,
          "databases" : null,
          "table_model_prefix" : "test_"
        }
      }, {
        "biz_type" : "TABLE_MODEL",
        "level" : null,
        "db" : 0,
        "tb" : 0,
        "tb_published" : 0,
        "fd" : 0,
        "fd_published" : 0,
        "st" : 0.0,
        "st_published" : 0.0,
        "model" : {
          "id" : "1230823879853875200",
          "name" : "LOGIC_B",
          "description" : "",
          "is_physical" : false,
          "frequent" : false,
          "top" : true,
          "level" : null,
          "dw_type" : "UNSPECIFIED",
          "create_time" : "2024-04-19T10:14:41+08:00",
          "update_time" : "2024-04-19T10:14:41+08:00",
          "create_by" : "test_uesr",
          "update_by" : "test_uesr",
          "type" : "THIRD_NF",
          "biz_catalog_ids" : null,
          "databases" : null,
          "table_model_prefix" : ""
        }
      } ],
      "logic" : [ {
        "biz_type" : "TABLE_MODEL",
        "level" : null,
        "db" : 0,
        "tb" : 0,
        "tb_published" : 0,
        "fd" : 0,
        "fd_published" : 0,
        "st" : 0.0,
        "st_published" : 0.0,
        "model" : {
          "id" : "1230823879853875200",
          "name" : "LOGIC_B",
          "description" : "",
          "is_physical" : false,
          "frequent" : false,
          "top" : true,
          "level" : null,
          "dw_type" : "UNSPECIFIED",
          "create_time" : "2024-04-19T10:14:41+08:00",
          "update_time" : "2024-04-19T10:14:41+08:00",
          "create_by" : "test_uesr",
          "update_by" : "test_uesr",
          "type" : "THIRD_NF",
          "biz_catalog_ids" : null,
          "databases" : null,
          "table_model_prefix" : ""
        }
      }, {
        "biz_type" : "TABLE_MODEL",
        "level" : null,
        "db" : 0,
        "tb" : 0,
        "tb_published" : 0,
        "fd" : 0,
        "fd_published" : 0,
        "st" : 0.0,
        "st_published" : 0.0,
        "model" : {
          "id" : "1230823841513799680",
          "name" : "LOGIC_A",
          "description" : "",
          "is_physical" : false,
          "frequent" : false,
          "top" : false,
          "level" : null,
          "dw_type" : "UNSPECIFIED",
          "create_time" : "2024-04-19T10:14:31+08:00",
          "update_time" : "2024-04-19T10:14:31+08:00",
          "create_by" : "test_uesr",
          "update_by" : "test_uesr",
          "type" : "THIRD_NF",
          "biz_catalog_ids" : null,
          "databases" : null,
          "table_model_prefix" : ""
        }
      }, {
        "biz_type" : "TABLE_MODEL",
        "level" : null,
        "db" : 0,
        "tb" : 4,
        "tb_published" : 3,
        "fd" : 12,
        "fd_published" : 9,
        "st" : 0.16666666666666666,
        "st_published" : 0.1111111111111111,
        "model" : {
          "id" : "1229432454457262080",
          "name" : "test_czh",
          "description" : "",
          "is_physical" : false,
          "frequent" : false,
          "top" : false,
          "level" : null,
          "dw_type" : "UNSPECIFIED",
          "create_time" : "2024-04-15T14:05:39+08:00",
          "update_time" : "2024-04-15T14:05:39+08:00",
          "create_by" : "test_uesr",
          "update_by" : "test_uesr",
          "type" : "THIRD_NF",
          "biz_catalog_ids" : null,
          "databases" : null,
          "table_model_prefix" : ""
        }
      }, {
        "biz_type" : "TABLE_MODEL",
        "level" : null,
        "db" : 0,
        "tb" : 11,
        "tb_published" : 10,
        "fd" : 25,
        "fd_published" : 23,
        "st" : 0.04,
        "st_published" : 0.043478260869565216,
        "model" : {
          "id" : "1169318954880122880",
          "name" : "logic_czh",
          "description" : "",
          "is_physical" : false,
          "frequent" : false,
          "top" : false,
          "level" : null,
          "dw_type" : "UNSPECIFIED",
          "create_time" : "2023-11-01T16:56:04+08:00",
          "update_time" : "2023-11-01T16:56:04+08:00",
          "create_by" : "test_uesr",
          "update_by" : "test_uesr",
          "type" : "THIRD_NF",
          "biz_catalog_ids" : null,
          "databases" : null,
          "table_model_prefix" : null
        }
      } ],
      "physical" : [ {
        "biz_type" : "TABLE_MODEL",
        "level" : null,
        "db" : 1,
        "tb" : 9,
        "tb_published" : 7,
        "fd" : 34,
        "fd_published" : 20,
        "st" : 0.08823529411764706,
        "st_published" : 0.1,
        "model" : {
          "id" : "1204448983481765888",
          "name" : "test_dws",
          "description" : "",
          "is_physical" : true,
          "frequent" : false,
          "top" : false,
          "level" : null,
          "dw_type" : "DWS",
          "create_time" : "2024-02-06T15:30:15+08:00",
          "update_time" : "2024-02-06T15:30:15+08:00",
          "create_by" : "test_uesr",
          "update_by" : "test_uesr",
          "type" : "THIRD_NF",
          "biz_catalog_ids" : null,
          "databases" : null,
          "table_model_prefix" : ""
        }
      }, {
        "biz_type" : "TABLE_MODEL",
        "level" : "SDI",
        "db" : 2,
        "tb" : 14,
        "tb_published" : 10,
        "fd" : 31,
        "fd_published" : 20,
        "st" : 0.06451612903225806,
        "st_published" : 0.1,
        "model" : {
          "id" : "1183882892003127296",
          "name" : "test_prefix_001",
          "description" : "",
          "is_physical" : true,
          "frequent" : false,
          "top" : true,
          "level" : "SDI",
          "dw_type" : "DWS",
          "create_time" : "2023-12-11T21:27:57+08:00",
          "update_time" : "2024-04-08T19:18:05+08:00",
          "create_by" : "test_uesr",
          "update_by" : "test_uesr",
          "type" : "THIRD_NF",
          "biz_catalog_ids" : null,
          "databases" : null,
          "table_model_prefix" : "test_"
        }
      }, {
        "biz_type" : "TABLE_MODEL",
        "level" : null,
        "db" : 0,
        "tb" : 2,
        "tb_published" : 2,
        "fd" : 4,
        "fd_published" : 4,
        "st" : 0.0,
        "st_published" : 0.0,
        "model" : {
          "id" : "1178728794341699584",
          "name" : "dws_czh",
          "description" : "",
          "is_physical" : true,
          "frequent" : false,
          "top" : false,
          "level" : null,
          "dw_type" : "DWS",
          "create_time" : "2023-11-27T16:07:24+08:00",
          "update_time" : "2024-04-08T19:13:13+08:00",
          "create_by" : "test_uesr",
          "update_by" : "test_uesr",
          "type" : "THIRD_NF",
          "biz_catalog_ids" : null,
          "databases" : null,
          "table_model_prefix" : "test_"
        }
      }, {
        "biz_type" : "TABLE_MODEL",
        "level" : null,
        "db" : 2,
        "tb" : 10,
        "tb_published" : 8,
        "fd" : 36,
        "fd_published" : 32,
        "st" : 0.08333333333333333,
        "st_published" : 0.09375,
        "model" : {
          "id" : "1169319480548048896",
          "name" : "mrs_hive_czh",
          "description" : "",
          "is_physical" : true,
          "frequent" : false,
          "top" : false,
          "level" : null,
          "dw_type" : "MRS_HIVE",
          "create_time" : "2023-11-01T16:58:09+08:00",
          "update_time" : "2023-11-01T16:58:09+08:00",
          "create_by" : "test_uesr",
          "update_by" : "test_uesr",
          "type" : "THIRD_NF",
          "biz_catalog_ids" : null,
          "databases" : null,
          "table_model_prefix" : null
        }
      } ],
      "dwr" : {
        "biz_type" : "DIMENSION",
        "level" : null,
        "db" : 5,
        "tb" : 24,
        "tb_published" : 21,
        "fd" : 387,
        "fd_published" : 378,
        "st" : 0.0,
        "st_published" : 0.0,
        "model" : null
      },
      "dm" : {
        "biz_type" : "AGGREGATION_LOGIC_TABLE",
        "level" : null,
        "db" : 2,
        "tb" : 12,
        "tb_published" : 7,
        "fd" : 77,
        "fd_published" : 35,
        "st" : 0.0,
        "st_published" : 0.0,
        "model" : null
      }
    }
  }
}

状态码： 400

{
  "error_code" : "DS.60xx",
  "error_msg" : "The user request is illegal."
}

状态码： 401

{
  "error_code" : "DS.60xx",
  "error_msg" : "User authentication failed."
}

状态码： 403

{
  "error_code" : "DS.60xx",
  "error_msg" : "The user does not have permission to call this API."
}

SDK代码示例

SDK代码示例如下。

      
       
         
         
           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 CountAllModelsSolution {

    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();
        CountAllModelsRequest request = new CountAllModelsRequest();
        try {
            CountAllModelsResponse response = client.countAllModels(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());
        }
    }
}

          

        

      
     

      
       
         
         
           # 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 = CountAllModelsRequest()
        response = client.count_all_models(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

          

        

      
     

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

          

        

      
     

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

状态码

状态码	描述
200	Success，返回data数据是AllModelStatisticVO信息。
400	BadRequest
401	Unauthorized
403	Forbidden

父主题：概览

上一篇：模型统计信息

下一篇：标准覆盖率统计信息

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问

关系建模统计信息

功能介绍

调用方法

URI

请求参数

响应参数

请求示例

响应示例

SDK代码示例

状态码

相关文档

意见反馈

文档内容是否对您有帮助？

7*24

备案

专业服务

退订

建议反馈

售前咨询热线