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

查找版本信息

功能介绍

通过名称、创建者、修改时间查找版本信息。

调用方法

请参见如何调用API

URI

GET /v2/{project_id}/design/versions

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

表2 Query参数

参数

是否必选

参数类型

描述

name

String

按名称或编码模糊查询。

create_by

String

按创建者查询。

biz_id

String

业务定义ID,ID字符串。

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(复合指标(新))。

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 PublishVersionVO objects

查询到的版本值对象(PublishVersionVO)数组。

total

Integer

符合搜索条件的记录总数。

表7 PublishVersionVO

参数

参数类型

描述

id

String

版本ID,ID字符串。

version_name

String

版本名称。

version_tag

String

版本标记,只读。

description

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

业务详情,只读。

biz_info_vo

Object

业务对象。

effect_objs

String

影响信息,只读。

change_props

String

变化信息,只读。

sql_ddl

String

SQL脚本,只读。

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生成状态,只读。

biz_metric

String

业务指标同步状态,只读。

summary_status

String

统一统计状态,只读。

is_current_version

Boolean

是否为当前版本,只读。

create_time

String

创建时间,只读,格式遵循RFC3339,精确到秒,UTC时区,即yyyy-mm-ddTHH:MM:SSZ,如1970-01-01T00:00:00Z。

create_by

String

创建人,只读。

状态码: 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

返回的数据信息。

请求示例

根据业务对象ID查找版本信息。

GET https://{endpoint}/v2/{project_id}/design/versions?biz_id=1193199235202428928

响应示例

状态码: 200

Success,返回data数据是PublishVersionVO数组,以及总数。

{
  "data" : {
    "value" : {
      "total" : 1,
      "records" : [ {
        "id" : "1196551286263267328",
        "version_name" : "V1.0",
        "version_tag" : "test_czh_001_2024-01-15_20-27-37_493",
        "description" : null,
        "biz_id" : "1193199235202428928",
        "biz_type" : "BIZ_METRIC",
        "biz_info" : null,
        "biz_info_vo" : null,
        "effect_objs" : null,
        "change_props" : null,
        "sql_ddl" : null,
        "physical_table" : null,
        "technical_asset" : null,
        "business_asset" : "CREATE_SUCCESS",
        "meta_data_link" : null,
        "data_quality" : null,
        "dlf_task" : null,
        "materialization" : null,
        "publish_to_dlm" : null,
        "biz_metric" : "CREATE_SUCCESS",
        "summary_status" : "SUMMARY_SUCCESS",
        "is_current_version" : true,
        "create_time" : "2024-01-15T20:27:37+08:00",
        "create_by" : "test_uesr"
      } ]
    }
  }
}

状态码: 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
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 SearchVersionsSolution {

    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();
        SearchVersionsRequest request = new SearchVersionsRequest();
        try {
            SearchVersionsResponse response = client.searchVersions(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
# 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 = SearchVersionsRequest()
        response = client.search_versions(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
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.SearchVersionsRequest{}
	response, err := client.SearchVersions(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

Success,返回data数据是PublishVersionVO数组,以及总数。

400

BadRequest

401

Unauthorized

403

Forbidden

相关文档