查询业务指标信息
功能介绍
通过名称、创建者、修改时间分页查找业务指标信息。
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/design/biz-metrics
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
project_id |
是 |
String |
项目ID，获取方法请参见项目ID和账号ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
name |
否 |
String |
按名称或编码模糊查询。 |
create_by |
否 |
String |
按创建者查询。 |
owner |
否 |
String |
按负责人查询。 |
status |
否 |
String |
业务状态。 枚举值：
|
sync_status |
否 |
String |
同步状态枚举。 枚举值：
|
sync_key |
否 |
Array |
同步任务类型枚举。 枚举值：
|
biz_catalog_id |
否 |
String |
所属的业务分层的ID。 |
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。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
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
参数 |
参数类型 |
描述 |
|---|---|---|
data |
data object |
data，统一的返回结果的最外层数据结构。 |
参数 |
参数类型 |
描述 |
|---|---|---|
id |
String |
编码，更新时必填，创建时为空，填写String类型替代Long类型。 |
name |
String |
指标名称。 |
code |
String |
指标编码，只读。 |
name_alias |
String |
指标别名。 |
biz_type |
String |
业务实体类型。 枚举值：
|
status |
String |
实体的发布状态，只读，创建和更新时无需填写。 枚举值：
|
biz_catalog_id |
String |
归属的流程架构的ID，填写String类型替代Long类型。 |
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 |
刷新频率。 枚举值：
|
apply_scenario |
String |
应用场景。 |
technical_metric |
String |
关联技术指标，填写String类型替代Long类型。 |
technical_metric_name |
String |
关联技术指标名称，只读。 |
technical_metric_type |
String |
业务实体类型。 枚举值：
|
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 |
自定义项 |
参数 |
参数类型 |
描述 |
|---|---|---|
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 |
业务实体类型。 枚举值：
|
biz_info |
String |
序列化之后的业务详情，类型是string。 |
biz_info_obj |
Object |
业务详情，类型是object。 |
biz_version |
Integer |
业务版本。 |
biz_status |
String |
实体的发布状态，只读，创建和更新时无需填写。 枚举值：
|
approval_status |
String |
业务审批状态，只读。 枚举值：
|
approval_type |
String |
业务审核类型。 枚举值：
|
submit_time |
String |
提交时间。 |
create_by |
String |
创建者。 |
l1 |
String |
主题域分组中文名，只读，创建和更新时无需填写。 |
l2 |
String |
主题域中文名，只读，创建和更新时无需填写。 |
l3 |
String |
业务对象中文名，只读，创建和更新时无需填写。 |
approval_time |
String |
审核时间。 |
approver |
String |
审核人。 |
String |
审核人邮箱。 |
|
msg |
String |
审核信息。 |
directory_path |
String |
目录树。 |
参数 |
参数类型 |
描述 |
|---|---|---|
id |
String |
ID信息，填写String类型替代Long类型。 |
biz_type |
String |
业务实体类型。 枚举值：
|
biz_id |
String |
业务ID，填写String类型替代Long类型。 |
biz_info |
String |
业务对象信息。 |
status |
String |
实体的发布状态，只读，创建和更新时无需填写。 枚举值：
|
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。 |
参数 |
参数类型 |
描述 |
|---|---|---|
fd_name_ch |
String |
自定义项中文名。 |
fd_name_en |
String |
自定义项英文名。 |
not_null |
Boolean |
是否必填。 |
fd_value |
String |
属性值。 |
状态码： 400
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码，如DS.6000，请求处理失败。 |
error_msg |
String |
错误信息。 |
data |
Object |
返回的数据信息。 |
状态码： 401
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码，如DS.6000，请求处理失败。 |
error_msg |
String |
错误信息。 |
data |
Object |
返回的数据信息。 |
状态码： 403
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码，如DS.6000，请求处理失败。 |
error_msg |
String |
错误信息。 |
data |
Object |
返回的数据信息。 |
请求示例
查询前十条业务指标数据，返回业务指标集合。
GET https://{endpoint}/v2/{project_id}/design/biz-metrics?page_start=1&page_size=10
响应示例
状态码： 200
Success，返回data数据是BizMetricVO数组，以及总数。
{
"data" : {
"value" : {
"total" : 1,
"records" : [ {
"id" : "1193199235202428928",
"name" : "test_czh_001",
"code" : "ZB000000",
"name_alias" : null,
"biz_type" : null,
"status" : "PUBLISHED",
"biz_catalog_id" : "1193122318579281920",
"biz_catalog_path" : "test_czh_001",
"create_by" : "ei_dayu_y00321344_01",
"update_by" : "ei_dayu_y00321344_01",
"data_origin" : null,
"unit" : null,
"time_filters" : "天",
"dimensions" : "",
"general_filters" : null,
"interval_type" : "MONTH",
"apply_scenario" : null,
"technical_metric" : null,
"technical_metric_name" : null,
"technical_metric_type" : null,
"measure" : null,
"owner" : "ei_dayu_y00321344_01",
"owner_department" : "sss",
"destination" : "测试",
"guid" : "ead2dc91-e81d-4590-94e3-5f7f69dd85b5",
"definition" : "没有特殊含义",
"expression" : "海伦凯勒公式",
"remark" : null,
"approval_info" : {
"id" : "1193199265908928512",
"tenant_id" : null,
"name_ch" : null,
"name_en" : null,
"biz_id" : "1193199235202428928",
"biz_type" : null,
"biz_info" : null,
"biz_info_obj" : null,
"biz_version" : 0,
"biz_status" : "PUBLISHED",
"approval_status" : "APPROVED",
"approval_type" : null,
"submit_time" : "2024-01-06T14:27:54+08:00",
"create_by" : null,
"l1" : null,
"l2" : null,
"l3" : null,
"approval_time" : "2024-01-15T20:27:37+08:00",
"approver" : "ei_dayu_y00321344_01",
"email" : null,
"msg" : "1",
"directory_path" : null
},
"new_biz" : null,
"create_time" : "2024-01-06T14:27:46+08:00",
"update_time" : "2024-01-15T20:27:37+08:00",
"l1" : "test_czh_001",
"l2" : null,
"l3" : null,
"biz_metric" : "CREATE_SUCCESS",
"summary_status" : "SUMMARY_SUCCESS",
"self_defined_fields" : null
} ]
}
}
}
状态码： 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 ListBizMetricsSolution { 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(); ListBizMetricsRequest request = new ListBizMetricsRequest(); try { ListBizMetricsResponse response = client.listBizMetrics(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 |
# coding: utf-8 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 = __import__('os').getenv("CLOUD_SDK_AK") sk = __import__('os').getenv("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 = ListBizMetricsRequest() response = client.list_biz_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) |
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.ListBizMetricsRequest{} response, err := client.ListBizMetrics(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 |
