文档首页/ 数据治理中心 DataArts Studio/ API参考/ 数据架构API/ 业务指标接口/ 获取指标关联信息
更新时间：2024-11-22 GMT+08:00
在线调试
CLI示例
查看PDF
分享

获取指标关联信息

功能介绍

获取当前指标图谱。

调用方法

请参见如何调用API。

URI

GET /v2/{project_id}/design/metric-relations/{id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方法请参见项目ID和账号ID。

id

是

String

实体ID，ID字符串。
表2 Query参数

参数

是否必选

参数类型

描述

biz_type

是

String

指标类型。

请求参数

表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

value object

value，统一的返回结果的外层数据结构。
表6 value

参数

参数类型

描述

all

Array of objects

所有的业务指标信息。

links

Object

指标关联。

groups

Object

分组。

total

Integer

总数。

状态码： 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码，如DS.6000，请求处理失败。

error_msg

String

错误信息。

data

Object

返回的数据信息。

状态码： 401

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码，如DS.6000，请求处理失败。

error_msg

String

错误信息。

data

Object

返回的数据信息。

状态码： 403

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码，如DS.6000，请求处理失败。

error_msg

String

错误信息。

data

Object

返回的数据信息。

请求示例

根据指标ID进行指标图谱查询。

GET https://{endpoint}/v2/{project_id}/design/metric-relations/1193199235202428928?biz_type=BIZ_METRIC

响应示例

状态码： 200

Success，返回data数据是MetricRelationVOList。

{
  "data" : {
    "value" : {
      "all" : [ {
        "vo" : {
          "id" : "1014197025488699392",
          "name_en" : "zonghe8830",
          "name_ch" : "zonghe8830(testweidu830)",
          "description" : "",
          "create_by" : "abc",
          "data_type" : "STRING",
          "l1_id" : null,
          "l2_id" : null,
          "l3_id" : "767858832738234368",
          "status" : "DRAFT",
          "atomic_index_id" : "1014195214723756032",
          "time_condition_id" : null,
          "time_field_id" : null,
          "time_field_name" : null,
          "common_conditions" : [ ],
          "dimension_groups" : [ {
            "group_id" : "1014194851576721408",
            "role" : null,
            "dimension_id" : "1014194851576721408",
            "hierarchies_id" : null,
            "ordinal" : 1,
            "group_name" : "testweidu830",
            "group_code" : "testweidu830",
            "biz_type" : "DIMENSION",
            "hierarchies" : null,
            "l1" : null,
            "l2" : null,
            "l3" : null,
            "l1_id" : null,
            "l2_id" : null,
            "l3_id" : null,
            "dw_type" : null,
            "id" : "1014197025585168384"
          } ],
          "monitor" : null,
          "atomic_index" : {
            "id" : "1014195214723756032",
            "name_en" : "zonghe8830",
            "name_ch" : "zonghe8830",
            "description" : "",
            "create_by" : null,
            "cal_exp" : "sum(${1014195020200325120}) ",
            "cal_fn_ids" : null,
            "l1_id" : null,
            "l2_id" : null,
            "l3_id" : null,
            "table_id" : "1014195020183547904",
            "tb_name" : null,
            "dw_type" : null,
            "field_ids" : [ "1014195020200325120" ],
            "field_names" : null,
            "status" : "DRAFT",
            "biz_type" : "FACT_LOGIC_TABLE",
            "create_time" : "2022-09-02T09:56:31.536+08:00",
            "update_time" : "2022-09-02T09:56:31.536+08:00",
            "l1" : null,
            "l2" : null,
            "l3" : null,
            "approval_info" : null,
            "new_biz" : null
          },
          "time_condition_name" : null,
          "create_time" : "2022-08-30T15:36:54+08:00",
          "update_time" : "2022-08-30T15:36:54+08:00",
          "l1" : null,
          "l2" : null,
          "l3" : null,
          "summary_table_id" : null,
          "approval_info" : null,
          "new_biz" : null
        },
        "id" : "1014197025488699392",
        "tables" : [ ],
        "biz_type" : "DERIVATIVE_INDEX",
        "parent_ids" : [ ],
        "child_ids" : [ "1014195214723756032" ]
      } ],
      "total" : 2,
      "groups" : {
        "1014194851576721408" : {
          "dimension_groups" : [ {
            "group_id" : "1014194851576721408",
            "role" : null,
            "dimension_id" : "1014194851576721408",
            "hierarchies_id" : null,
            "ordinal" : 1,
            "group_name" : "testweidu830",
            "group_code" : "testweidu830",
            "biz_type" : "DIMENSION",
            "hierarchies" : null,
            "l1" : null,
            "l2" : null,
            "l3" : null,
            "l1_id" : null,
            "l2_id" : null,
            "l3_id" : null,
            "dw_type" : null,
            "id" : "1014197025585168384"
          } ],
          "ids" : [ "1014197025488699392" ]
        }
      },
      "links" : {
        "vo" : {
          "id" : "1014197025488699392",
          "name_en" : "zonghe8830",
          "name_ch" : "zonghe8830(testweidu830)",
          "description" : "",
          "create_by" : "abc",
          "data_type" : "STRING",
          "l1_id" : null,
          "l2_id" : null,
          "l3_id" : "767858832738234368",
          "status" : "DRAFT",
          "atomic_index_id" : "1014195214723756032",
          "time_condition_id" : null,
          "time_field_id" : null,
          "time_field_name" : null,
          "common_conditions" : [ ],
          "dimension_groups" : [ {
            "group_id" : "1014194851576721408",
            "role" : null,
            "dimension_id" : "1014194851576721408",
            "hierarchies_id" : null,
            "ordinal" : 1,
            "group_name" : "testweidu830",
            "group_code" : "testweidu830",
            "biz_type" : "DIMENSION",
            "hierarchies" : null,
            "l1" : null,
            "l2" : null,
            "l3" : null,
            "l1_id" : null,
            "l2_id" : null,
            "l3_id" : null,
            "dw_type" : null,
            "id" : "1014197025585168384"
          } ],
          "monitor" : null,
          "atomic_index" : {
            "id" : "1014195214723756032",
            "name_en" : "zonghe8830",
            "name_ch" : "zonghe8830",
            "description" : "",
            "create_by" : null,
            "cal_exp" : "sum(${1014195020200325120}) ",
            "cal_fn_ids" : null,
            "l1_id" : null,
            "l2_id" : null,
            "l3_id" : null,
            "table_id" : "1014195020183547904",
            "tb_name" : null,
            "dw_type" : null,
            "field_ids" : [ "1014195020200325120" ],
            "field_names" : null,
            "status" : "DRAFT",
            "biz_type" : "FACT_LOGIC_TABLE",
            "create_time" : "2022-09-02T09:56:31.536+08:00",
            "update_time" : "2022-09-02T09:56:31.536+08:00",
            "l1" : null,
            "l2" : null,
            "l3" : null,
            "approval_info" : null,
            "new_biz" : null
          },
          "time_condition_name" : null,
          "create_time" : "2022-08-30T15:36:54+08:00",
          "update_time" : "2022-08-30T15:36:54+08:00",
          "l1" : null,
          "l2" : null,
          "l3" : null,
          "summary_table_id" : null,
          "approval_info" : null,
          "new_biz" : null
        },
        "id" : "1014197025488699392",
        "tables" : [ ],
        "biz_type" : "DERIVATIVE_INDEX",
        "parent_ids" : [ ],
        "child_ids" : [ "1014195214723756032" ]
      }
    }
  }
}

状态码： 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代码示例如下。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
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 ListMetricRelationsSolution {

    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();
        ListMetricRelationsRequest request = new ListMetricRelationsRequest();
        request.withId("{id}");
        try {
            ListMetricRelationsResponse response = client.listMetricRelations(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());
        }
    }
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
 
# 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 = ListMetricRelationsRequest()
        request.id = "{id}"
        response = client.list_metric_relations(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
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.ListMetricRelationsRequest{}
	request.Id = "{id}"
	response, err := client.ListMetricRelations(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

Success，返回data数据是MetricRelationVOList。

400

BadRequest

401

Unauthorized

403

Forbidden
父主题： 业务指标接口