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

总览统计信息

功能介绍

总览统计信息。

调用方法

请参见如何调用API

URI

GET /v2/{project_id}/design/definitions/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

StatisticInfo object

value,统一的返回结果的外层数据结构。

表5 StatisticInfo

参数

参数类型

描述

atomic_index

StatisticSchema object

原子指标。

derivative_index

StatisticSchema object

衍生指标。

compound_metric

StatisticSchema object

复合指标。

biz_index

StatisticSchema object

业务指标。

dimension

StatisticSchema object

维度。

condition_group

StatisticSchema object

限定分组。

time_condition

StatisticSchema object

时间限定。

common_condition

StatisticSchema object

通用限定。

dimension_logic_table

StatisticSchema object

维度表。

fact_logic_table

StatisticSchema object

事实表。

aggregation_logic_table

StatisticSchema object

汇总表。

data_standard

StatisticSchema object

数据标准。

table_model

StatisticSchema object

业务表。

lookup_table

StatisticSchema object

码表。

pending_review

Integer

待我审核。

my_applications

Integer

我的申请。

表6 StatisticSchema

参数

参数类型

描述

increase

Integer

本月新增。

total

Integer

总量。

standard_coverage

Double

标准覆盖率。

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

返回的数据信息。

请求示例

总览页面统计信息。

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

响应示例

状态码: 200

Success,返回data数据是StatisticInfo信息。

{
  "data" : {
    "value" : {
      "atomic_index" : {
        "increase" : 0,
        "total" : 5,
        "standard_coverage" : null
      },
      "derivative_index" : {
        "increase" : 0,
        "total" : 8,
        "standard_coverage" : null
      },
      "compound_metric" : {
        "increase" : 0,
        "total" : 3,
        "standard_coverage" : null
      },
      "biz_index" : {
        "increase" : 0,
        "total" : 1,
        "standard_coverage" : null
      },
      "dimension" : {
        "increase" : 1,
        "total" : 22,
        "standard_coverage" : null
      },
      "condition_group" : null,
      "time_condition" : {
        "increase" : 0,
        "total" : 14,
        "standard_coverage" : null
      },
      "common_condition" : null,
      "dimension_logic_table" : {
        "increase" : 1,
        "total" : 17,
        "standard_coverage" : null
      },
      "fact_logic_table" : {
        "increase" : 0,
        "total" : 7,
        "standard_coverage" : null
      },
      "aggregation_logic_table" : {
        "increase" : 0,
        "total" : 12,
        "standard_coverage" : null
      },
      "data_standard" : {
        "increase" : 1,
        "total" : 13,
        "standard_coverage" : null
      },
      "table_model" : {
        "increase" : 15,
        "total" : 50,
        "standard_coverage" : 0.0775
      },
      "lookup_table" : {
        "increase" : 2,
        "total" : 10,
        "standard_coverage" : null
      },
      "pending_review" : 1,
      "my_applications" : 1
    }
  }
}

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

    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();
        CountOverviewsRequest request = new CountOverviewsRequest();
        try {
            CountOverviewsResponse response = client.countOverviews(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 = CountOverviewsRequest()
        response = client.count_overviews(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.CountOverviewsRequest{}
	response, err := client.CountOverviews(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

Success,返回data数据是StatisticInfo信息。

400

BadRequest

401

Unauthorized

403

Forbidden