更新复合指标
功能介绍
根据参数,更新复合指标。
调用方法
请参见如何调用API。
URI
PUT /v2/{project_id}/design/compound-metrics
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方法请参见项目ID和账号ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
id |
否 |
String |
复合指标ID,ID字符串。更新时必填。 |
name_en |
是 |
String |
复合指标英文名称。 |
name_ch |
是 |
String |
复合指标名称。 |
description |
否 |
String |
描述 |
dimension_group |
是 |
String |
统计维度ID,更新时不可修改此值。 |
compound_type |
是 |
String |
复合指标类型。 枚举值:
|
comparison_type |
否 |
String |
同比配置,复合指标类型为“同比增长率”时必填。 枚举值:
|
metric_ids |
否 |
Array of strings |
设定衍生指标,复合指标类型为“同比增长率”或“环比增长率”时必填,ID字符串。 |
metric_names |
否 |
Array of strings |
指标名称信息。 |
compound_metric_ids |
否 |
Array of strings |
复合指标信息,ID字符串。 |
compound_metric_names |
否 |
Array of strings |
复合指标名称信息。 |
cal_fn_ids |
否 |
Array of strings |
引用函数ID,ID字符串。 |
cal_exp |
否 |
String |
计算表达式,复合指标类型为“表达式”时必填。形如${index_id} + ${compound#index_id},其中index_id代表引用的衍生指标ID,compound#index_id代表引用的复合指标ID。 |
l2_id |
否 |
String |
主题域ID。 |
l3_id |
是 |
String |
业务对象ID,ID字符串。 |
data_type |
是 |
String |
字段类型。 |
create_by |
否 |
String |
创建人。 |
update_by |
否 |
String |
更新人。 |
status |
否 |
String |
实体的发布状态,只读,创建和更新时无需填写。 枚举值:
|
approval_info |
否 |
ApprovalVO object |
审批信息,只读参数。业务对象最近一次的审批信息,包括审批的业务详情、审核人信息、审核时间等。 |
new_biz |
否 |
BizVersionManageVO object |
业务版本管理,只读。 |
monitor |
否 |
MetricMonitorVO object |
指标监控信息。 |
l1 |
否 |
String |
主题域分组中文名,只读,创建和更新时无需填写。 |
l2 |
否 |
String |
主题域中文名,只读,创建和更新时无需填写。 |
l3 |
否 |
String |
业务对象中文名,只读,创建和更新时无需填写。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
id |
否 |
String |
审批单ID,ID字符串。 |
tenant_id |
否 |
String |
项目ID,获取方式参考接口路径参数“project_id”。 |
name_ch |
否 |
String |
业务中文名。 |
name_en |
否 |
String |
业务英文名。 |
biz_id |
否 |
String |
业务ID,ID字符串。 |
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信息,ID字符串。 |
biz_type |
否 |
String |
业务实体类型。 枚举值:
|
biz_id |
否 |
String |
业务ID,ID字符串。 |
biz_info |
否 |
String |
业务对象信息。 |
status |
否 |
String |
实体的发布状态,只读,创建和更新时无需填写。 枚举值:
|
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
data |
data object |
更新复合指标的返回结果,成功的个数。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
复合指标ID,ID字符串。更新时必填。 |
name_en |
String |
复合指标英文名称。 |
name_ch |
String |
复合指标名称。 |
description |
String |
描述 |
dimension_group |
String |
统计维度ID,更新时不可修改此值。 |
group_name |
String |
颗粒度名称,只读。 |
group_code |
String |
颗粒度编码,只读。 |
compound_type |
String |
复合指标类型。 枚举值:
|
comparison_type |
String |
同比配置,复合指标类型为“同比增长率”时必填。 枚举值:
|
metric_ids |
Array of strings |
设定衍生指标,复合指标类型为“同比增长率”或“环比增长率”时必填,ID字符串。 |
metric_names |
Array of strings |
指标名称信息。 |
compound_metric_ids |
Array of strings |
复合指标信息,ID字符串。 |
compound_metric_names |
Array of strings |
复合指标名称信息。 |
cal_fn_ids |
Array of strings |
引用函数ID,ID字符串。 |
cal_exp |
String |
计算表达式,复合指标类型为“表达式”时必填。形如${index_id} + ${compound#index_id},其中index_id代表引用的衍生指标ID,compound#index_id代表引用的复合指标ID。 |
l1_id |
String |
主题域分组ID,只读,ID字符串。 |
l2_id |
String |
主题域ID。 |
l3_id |
String |
业务对象ID,ID字符串。 |
data_type |
String |
字段类型。 |
create_by |
String |
创建人。 |
update_by |
String |
更新人。 |
status |
String |
实体的发布状态,只读,创建和更新时无需填写。 枚举值:
|
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,只读,ID字符串。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
审批单ID,ID字符串。 |
tenant_id |
String |
项目ID,获取方式参考接口路径参数“project_id”。 |
name_ch |
String |
业务中文名。 |
name_en |
String |
业务英文名。 |
biz_id |
String |
业务ID,ID字符串。 |
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信息,ID字符串。 |
biz_type |
String |
业务实体类型。 枚举值:
|
biz_id |
String |
业务ID,ID字符串。 |
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。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
编码,ID字符串。 |
other_metric_ids |
Array of strings |
其他指标ID,ID字符串。 |
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,ID字符串。 |
front_configs |
String |
前端表达式配置,用于前端数据恢复。 |
metric_type |
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 |
返回的数据信息。 |
请求示例
根据下列参数,更新复合指标。
PUT https://{endpoint}/v2/{project_id}/design/compound-metrics { "id" : "1300537267533774848", "name_ch" : "测试复合指标", "name_en" : "test_compound_index", "l3_id" : "1169309252771299328", "dimension_group" : "1169322847009742848", "data_type" : "STRING", "compound_type" : "EXPRESSION", "monitor" : { "id" : null, "other_metric_ids" : [ ], "other_compound_metric_ids" : [ ], "expression" : "", "metric_id" : "1300537267533774848", "metric_type" : "COMPOUND_METRIC" }, "description" : "", "metric_ids" : [ "1300493917942329344", "1268168163686780928", "1181167466668310528" ], "compound_metric_ids" : [ ], "cal_exp" : "${1300493917942329344}+${1268168163686780928}+${1181167466668310528}" }
响应示例
状态码: 200
Success,返回data数据是 CompoundMetricVO。
{ "value" : { "id" : "1300537267533774848", "name_en" : "test_compound_index", "name_ch" : "测试复合指标", "description" : "", "dimension_group" : "1169322847009742848", "group_name" : null, "group_code" : null, "compound_type" : "EXPRESSION", "comparison_type" : null, "metric_ids" : [ "1300493917942329344", "1268168163686780928", "1181167466668310528" ], "metric_names" : null, "compound_metric_ids" : [ ], "compound_metric_names" : null, "cal_fn_ids" : null, "cal_exp" : "${1300493917942329344}+${1268168163686780928}+${1181167466668310528}", "l1_id" : null, "l2_id" : null, "l3_id" : "1169309252771299328", "data_type" : "STRING", "create_by" : "test_user", "update_by" : "test_user", "status" : "DRAFT", "create_time" : "2024-10-28T19:10:47+08:00", "update_time" : "2024-10-28T19:20:23.085+08:00", "approval_info" : null, "new_biz" : null, "monitor" : null, "l1" : null, "l2" : null, "l3" : null, "summary_table_id" : 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." }
状态码
状态码 |
描述 |
---|---|
200 |
Success,返回data数据是 CompoundMetricVO。 |
400 |
BadRequest |
401 |
Unauthorized |
403 |
Forbidden |