查找复合指标

功能介绍

通过中英文名称、创建者、审核人、状态、修改时间、l3Id分页查找复合指标信息。

调用方法

请参见如何调用API。

URI

GET /v2/{project_id}/design/compound-metrics

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

表2 Query参数
参数	是否必选	参数类型	描述
name	否	String	按名称或编码模糊查询。
create_by	否	String	按创建者查询。
approver	否	String	按审核人查询。
status	否	String	业务状态。枚举值： DRAFT: 草稿 PUBLISH_DEVELOPING: 发布待审批 PUBLISHED: 已发布 OFFLINE_DEVELOPING: 下线待审批 OFFLINE: 已下线 REJECT: 已驳回
dimension_group	否	String	依据维度颗粒度查维度属性。
atomic_index_id	否	String	依据原子指标ID查维度属性，填写String类型替代Long类型。
l3_id	否	String	业务对象l3的ID，填写String类型替代Long类型。
begin_time	否	String	时间过滤左边界，与end_time一起使用，只支持时间范围过滤，单边过滤无效。格式遵循RFC3339，精确到秒，UTC时区，即yyyy-mm-ddTHH:MM:SSZ，如1970-01-01T00:00:00Z。
end_time	否	String	时间过滤右边界，与begin_time一起使用只支持时间范围过滤，单边过滤无效。格式遵循RFC3339，精确到秒，UTC时区，即yyyy-mm-ddTHH:MM:SSZ，如1970-01-01T00:00:00Z。
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。
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	返回数据。

表5 data
参数	参数类型	描述
value	value object	返回的数据信息。

表6 value
参数	参数类型	描述
records	Array of CompoundMetricVO objects	CompoundMetricVO数组。
total	Integer	总数。

表7 CompoundMetricVO
参数	参数类型	描述
id	String	编码，填写String类型替代Long类型。
name_en	String	字段名。
name_ch	String	业务属性。
description	String	描述
dimension_group	String	颗粒度ID。
group_name	String	颗粒度名称，只读。
group_code	String	颗粒度编码，只读。
compound_type	String	复合指标类型。枚举值： EXPRESSION: 表达式 PERIODICITY_VALUED_COMPARISON: 环比 INTERVAL_VALUED_COMPARISON: 同比
comparison_type	String	比较类型。枚举值： YEAR_TO_YEAR: 年同比 MONTH_TO_MONTH: 月同比 WEEK_TO_WEEK: 周同比
metric_ids	Array of strings	指标信息，填写String类型替代Long类型。
metric_names	Array of strings	指标名称信息。
compound_metric_ids	Array of strings	复合指标信息，填写String类型替代Long类型。
compound_metric_names	Array of strings	复合指标名称信息
cal_fn_ids	Array of strings	引用函数ID，填写String类型替代Long类型。
cal_exp	String	计算表达式，形如${index_id} + ${compound#index_id}，其中index_id代表引用的衍生指标ID，compound#index_id代表引用的复合指标ID。
l1_id	String	主题域分组ID，只读，填写String类型替代Long类型。
l2_id	String	主题域ID。
l3_id	String	业务对象ID，填写String类型替代Long类型。
data_type	String	字段类型。
create_by	String	创建人。
update_by	String	更新人。
status	String	实体的发布状态，只读，创建和更新时无需填写。枚举值： DRAFT: 草稿 PUBLISH_DEVELOPING: 发布待审核 PUBLISHED: 已发布 OFFLINE_DEVELOPING: 下线待审核 OFFLINE: 已下线 REJECT: 已驳回
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。
approval_info	ApprovalVO object	审批信息,只读参数。业务对象最近一次的审批信息，包括审批的业务详情、审核人信息、审核时间等。
new_biz	BizVersionManageVO object	业务版本管理，只读。
monitor	MetricMonitorVO object	指标监控信息。
l1	String	主题域分组中文名，只读，创建和更新时无需填写。
l2	String	主题域中文名，只读，创建和更新时无需填写。
l3	String	业务对象中文名，只读，创建和更新时无需填写。
summary_table_id	String	汇总表ID，只读，填写String类型替代Long类型。

表8 ApprovalVO
参数	参数类型	描述
id	String	审批单ID，填写String类型替代Long类型。
tenant_id	String	项目ID，获取方式参考接口路径参数“project_id”。
name_ch	String	业务中文名。
name_en	String	业务英文名。
biz_id	String	业务ID，填写String类型替代Long类型。
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	目录树。

表9 BizVersionManageVO
参数	参数类型	描述
id	String	ID信息，填写String类型替代Long类型。
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，填写String类型替代Long类型。
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。

**表10** MetricMonitorVO
参数	参数类型	描述
id	String	编码，填写String类型替代Long类型。
other_metric_ids	Array of strings	其他指标ID，填写String类型替代Long类型。
other_metric_names	Array of strings	其他指标名称，只读。
other_compound_metric_ids	Array of strings	其他复合指标ID。
other_compound_metric_names	Array of strings	其他复合指标名称。
expression	String	告警表达式。
metric_id	String	挂载指ID，填写String类型替代Long类型。
front_configs	String	前端表达式配置，用于前端数据恢复。
metric_type	String	挂载指标类型。

状态码： 400

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

状态码： 401

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

状态码： 403

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

请求示例

根据查询条件，分页查询复合指标列表。

GET https://{endpoint}/v2/{project_id}/design/compound-metrics?offset=1&limit=10&name=com_

响应示例

状态码： 200

Success，返回data数据是CompoundMetricVO数组，以及总数。

{
  "data" : {
    "value" : {
      "total" : 1,
      "records" : [ {
        "id" : "1170056628536553472",
        "name_en" : "com_compound_metric_test",
        "name_ch" : "复合指标测试",
        "description" : "",
        "dimension_group" : "1169322847009742848,1169329693619625984.1169329693695123460.1169327565677182976",
        "group_name" : "供应商,行程订单.下车时间",
        "group_code" : null,
        "compound_type" : "EXPRESSION",
        "comparison_type" : null,
        "metric_ids" : [ "1170007051066355712" ],
        "metric_names" : null,
        "compound_metric_ids" : [ ],
        "compound_metric_names" : null,
        "cal_fn_ids" : null,
        "cal_exp" : "${1170007051066355712}/2",
        "l1_id" : "1169309252771299328",
        "l2_id" : "1169309374670356480,1169310587398889472",
        "l3_id" : null,
        "data_type" : "BIGINT",
        "create_by" : "test_uesr",
        "update_by" : "test_uesr",
        "status" : "PUBLISHED",
        "create_time" : "2023-11-03T17:47:19+08:00",
        "update_time" : "2023-11-03T17:55:12+08:00",
        "approval_info" : {
          "id" : "1170056629291528192",
          "tenant_id" : null,
          "name_ch" : null,
          "name_en" : null,
          "biz_id" : "1170056628536553472",
          "biz_type" : null,
          "biz_info" : null,
          "biz_info_obj" : null,
          "biz_version" : 0,
          "biz_status" : "PUBLISHED",
          "approval_status" : "APPROVED",
          "approval_type" : null,
          "submit_time" : "2023-11-03T17:47:19+08:00",
          "create_by" : null,
          "l1" : null,
          "l2" : null,
          "l3" : null,
          "approval_time" : "2023-11-03T17:55:12+08:00",
          "approver" : "test_uesr",
          "email" : null,
          "msg" : "Fast Approval OK.",
          "directory_path" : null
        },
        "new_biz" : null,
        "monitor" : null,
        "l1" : "城市交通",
        "l2" : "行程记录/行程事实",
        "l3" : null,
        "summary_table_id" : "1170007052639219712"
      } ]
    }
  }
}

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

    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();
        ListCompoundMetricsRequest request = new ListCompoundMetricsRequest();
        try {
            ListCompoundMetricsResponse response = client.listCompoundMetrics(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 = ListCompoundMetricsRequest()
        response = client.list_compound_metrics(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.ListCompoundMetricsRequest{}
	response, err := client.ListCompoundMetrics(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

          

        

      
     