文档首页/ 数据治理中心 DataArts Studio/ API参考/ 数据架构API/ 业务指标接口/ 查看指标详情

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

在线调试

CLI示例

查看PDF

查看指标详情

功能介绍

通过ID查看指标的详情信息。

调用方法

请参见如何调用API。

URI

GET /v2/{project_id}/design/biz-metrics/{id}

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

表2 Query参数
参数	是否必选	参数类型	描述
latest	否	Boolean	是否查询最新的。

请求参数

表3 请求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

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

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

表6 BizMetricVO
参数	参数类型	描述
id	String	编码，更新时必填，创建时为空，ID字符串。
name	String	指标名称。
code	String	指标编码，只读。
name_alias	String	指标别名。
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: 时间限定
status	String	实体的发布状态，只读，创建和更新时无需填写。枚举值： DRAFT: 草稿 PUBLISH_DEVELOPING: 发布待审核 PUBLISHED: 已发布 OFFLINE_DEVELOPING: 下线待审核 OFFLINE: 已下线 REJECT: 已驳回
biz_catalog_id	String	归属的流程架构的ID，ID字符串。
biz_catalog_path	String	归属的流程架构路径，只读。
create_by	String	创建人，只读。
update_by	String	更新人，只读。
data_origin	String	数据来源。
unit	String	计量单位。
time_filters	String	统计周期(时间限定)。
dimensions	String	统计维度。
general_filters	String	统计口径和修饰词。
interval_type	String	刷新频率。枚举值： MINUTE: 每分钟 HOUR: 每小时 DAY: 每天 WEEK: 每周 MONTH: 每月 YEAR: 每年 REAL_TIME: 实时 HALF_HOUR: 每半小时 QUART: 每15分钟 DOUBLE_WEEK: 每两周 HALF_YEAR: 每半年 HALF_DAY: 每半天
apply_scenario	String	应用场景。
technical_metric	String	关联技术指标，ID字符串。
technical_metric_name	String	关联技术指标名称，只读。
technical_metric_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: 时间限定
measure	String	度量对象。
owner	String	指标责任人。
owner_department	String	指标管理部门。
destination	String	设置目的。
guid	String	资产同步后的guid，只读。
definition	String	指标定义。
expression	String	计算公式。
remark	String	备注。
approval_info	ApprovalVO object	审批信息,只读参数。业务对象最近一次的审批信息，包括审批的业务详情、审核人信息、审核时间等。
new_biz	BizVersionManageVO object	业务版本管理，只读。
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。
l1	String	主题域分组中文名，只读，创建和更新时无需填写。
l2	String	主题域中文名，只读，创建和更新时无需填写。
l3	String	业务对象中文名，只读，创建和更新时无需填写。
biz_metric	String	业务指标同步状态，只读。
summary_status	String	同步统计状态，只读。
self_defined_fields	Array of SelfDefinedFieldVO objects	自定义项

表7 ApprovalVO
参数	参数类型	描述
id	String	审批单ID，ID字符串。
tenant_id	String	项目ID，获取方式参考接口路径参数“project_id”。
name_ch	String	业务中文名。
name_en	String	业务英文名。
biz_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_info	String	序列化之后的业务详情，类型是string。
biz_info_obj	Object	业务详情，类型是object。
biz_version	Integer	业务版本。
biz_status	String	实体的发布状态，只读，创建和更新时无需填写。枚举值： DRAFT: 草稿 PUBLISH_DEVELOPING: 发布待审核 PUBLISHED: 已发布 OFFLINE_DEVELOPING: 下线待审核 OFFLINE: 已下线 REJECT: 已驳回
approval_status	String	业务审批状态，只读。枚举值： DEVELOPING: 审核中 APPROVED: 审核通过 REJECT: 审核驳回 WITHDREW: 审核撤销
approval_type	String	业务审核类型。枚举值： PUBLISH: 发布 OFFLINE: 下线
submit_time	String	提交时间。
create_by	String	创建者。
l1	String	主题域分组中文名，只读，创建和更新时无需填写。
l2	String	主题域中文名，只读，创建和更新时无需填写。
l3	String	业务对象中文名，只读，创建和更新时无需填写。
approval_time	String	审核时间。
approver	String	审核人。
email	String	审核人邮箱。
msg	String	审核信息。
directory_path	String	目录树。

表8 BizVersionManageVO
参数	参数类型	描述
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。

表9 SelfDefinedFieldVO
参数	参数类型	描述
fd_name_ch	String	自定义项中文名。
fd_name_en	String	自定义项英文名。
not_null	Boolean	是否必填。
fd_value	String	属性值。

状态码： 400

**表10** 响应Body参数
参数	参数类型	描述
error_code	String	错误码，如DS.6000，请求处理失败。
error_msg	String	错误信息。
data	Object	返回的数据信息。

状态码： 401

**表11** 响应Body参数
参数	参数类型	描述
error_code	String	错误码，如DS.6000，请求处理失败。
error_msg	String	错误信息。
data	Object	返回的数据信息。

状态码： 403

**表12** 响应Body参数
参数	参数类型	描述
error_code	String	错误码，如DS.6000，请求处理失败。
error_msg	String	错误信息。
data	Object	返回的数据信息。

请求示例

根据业务指标ID，查询业务指标详情。

GET https://{endpoint}/v2/{project_id}/design/biz-metrics/1231249989901135872

响应示例

状态码： 200

Success，返回data数据是BizMetricVO详情。

{
  "data" : {
    "value" : {
      "id" : "1231249989901135872",
      "name" : "test_update_biz_metrics",
      "code" : "ZB000001",
      "name_alias" : "",
      "biz_type" : null,
      "status" : "DRAFT",
      "biz_catalog_id" : "1200479561188536320",
      "biz_catalog_path" : "aaa001",
      "create_by" : "test_uesr",
      "update_by" : "test_uesr",
      "data_origin" : "",
      "unit" : "",
      "time_filters" : "月度",
      "dimensions" : "test_czh_0305_001",
      "general_filters" : "",
      "interval_type" : "HOUR",
      "apply_scenario" : "",
      "technical_metric" : null,
      "technical_metric_name" : null,
      "technical_metric_type" : null,
      "measure" : "",
      "owner" : "test_uesr",
      "owner_department" : "data owner dept",
      "destination" : "业务人员对此业务指标的设置目的进行描述",
      "guid" : null,
      "definition" : "比如：按月对数据库某张表的某个字段进行均值计算。",
      "expression" : "avg(table.column)",
      "remark" : "该业务指标有啥需要注意的地方。",
      "approval_info" : null,
      "new_biz" : null,
      "create_time" : "2024-04-20T14:27:53+08:00",
      "update_time" : "2024-04-20T14:31:44+08:00",
      "l1" : "aaa001",
      "l2" : null,
      "l3" : null,
      "biz_metric" : null,
      "summary_status" : null,
      "self_defined_fields" : [ ]
    }
  }
}

状态码： 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 ShowBizMetricByIdSolution {

    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();
        ShowBizMetricByIdRequest request = new ShowBizMetricByIdRequest();
        request.withId("{id}");
        try {
            ShowBizMetricByIdResponse response = client.showBizMetricById(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 = ShowBizMetricByIdRequest()
        request.id = "{id}"
        response = client.show_biz_metric_by_id(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.ShowBizMetricByIdRequest{}
	request.Id = "{id}"
	response, err := client.ShowBizMetricById(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

          

        

      
     

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

状态码

状态码	描述
200	Success，返回data数据是BizMetricVO详情。
400	BadRequest
401	Unauthorized
403	Forbidden

父主题：业务指标接口

上一篇：删除业务指标

下一篇：查看指标维度信息

意见反馈

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

有帮助没帮助

提供反馈

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

系统繁忙，请稍后重试

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

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

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

字符长度不能超过500

直接提交取消

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

智能客服提问云社区提问

查看指标详情

功能介绍

调用方法

URI

请求参数

响应参数

请求示例

响应示例

SDK代码示例

状态码

相关文档

意见反馈

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

7*24

备案

专业服务

退订

建议反馈

售前咨询热线