文档首页/ 数据治理中心 DataArts Studio/ API参考/ 数据架构API/ 复合指标接口/ 新建复合指标

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

在线调试

CLI示例

查看PDF

新建复合指标

功能介绍

根据参数，新建复合指标。

调用方法

请参见如何调用API。

URI

POST /v2/{project_id}/design/compound-metrics

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID，获取方法请参见项目ID和账号ID。

请求参数

表2 请求Body参数
参数	是否必选	参数类型	描述
id	否	String	编码，填写String类型替代Long类型。
name_en	是	String	字段名。
name_ch	是	String	业务属性。
description	否	String	描述
dimension_group	是	String	颗粒度ID。
compound_type	否	String	复合指标类型。枚举值： EXPRESSION: 表达式 PERIODICITY_VALUED_COMPARISON: 环比 INTERVAL_VALUED_COMPARISON: 同比
comparison_type	否	String	比较类型。枚举值： YEAR_TO_YEAR: 年同比 MONTH_TO_MONTH: 月同比 WEEK_TO_WEEK: 周同比
metric_ids	是	Array of strings	指标信息，填写String类型替代Long类型。
metric_names	否	Array of strings	指标名称信息。
compound_metric_ids	否	Array of strings	复合指标信息，填写String类型替代Long类型。
compound_metric_names	否	Array of strings	复合指标名称信息
cal_fn_ids	否	Array of strings	引用函数ID，填写String类型替代Long类型。
cal_exp	是	String	计算表达式，形如${index_id} + ${compound#index_id}，其中index_id代表引用的衍生指标ID，compound#index_id代表引用的复合指标ID。
l2_id	否	String	主题域ID。
l3_id	否	String	业务对象ID，填写String类型替代Long类型。
data_type	否	String	字段类型。
create_by	否	String	创建人。
update_by	否	String	更新人。
status	否	String	实体的发布状态，只读，创建和更新时无需填写。枚举值： DRAFT: 草稿 PUBLISH_DEVELOPING: 发布待审核 PUBLISHED: 已发布 OFFLINE_DEVELOPING: 下线待审核 OFFLINE: 已下线 REJECT: 已驳回
approval_info	否	ApprovalVO object	审批信息,只读参数。业务对象最近一次的审批信息，包括审批的业务详情、审核人信息、审核时间等。
new_biz	否	BizVersionManageVO object	业务版本管理，只读。
monitor	否	MetricMonitorVO object	指标监控信息。
l1	否	String	主题域分组中文名，只读，创建和更新时无需填写。
l2	否	String	主题域中文名，只读，创建和更新时无需填写。
l3	否	String	业务对象中文名，只读，创建和更新时无需填写。

表3 ApprovalVO
参数	是否必选	参数类型	描述
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	业务实体类型。枚举值： 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	序列化之后的业务详情，类型是string。
biz_info_obj	否	Object	业务详情，类型是object。
biz_version	否	Integer	业务版本。
biz_status	否	String	实体的发布状态，只读，创建和更新时无需填写。枚举值： DRAFT: 草稿 PUBLISH_DEVELOPING: 发布待审核 PUBLISHED: 已发布 OFFLINE_DEVELOPING: 下线待审核 OFFLINE: 已下线 REJECT: 已驳回
approval_status	否	String	业务审批状态，只读。枚举值： DEVELOPING: 审核中 APPROVED: 审核通过 REJECT: 审核驳回 WITHDREW: 审核撤销
approval_type	否	String	业务审核类型。枚举值： PUBLISH: 发布 OFFLINE: 下线
submit_time	否	String	提交时间。
create_by	否	String	创建者。
l1	否	String	主题域分组中文名，只读，创建和更新时无需填写。
l2	否	String	主题域中文名，只读，创建和更新时无需填写。
l3	否	String	业务对象中文名，只读，创建和更新时无需填写。
approval_time	否	String	审核时间。
approver	否	String	审核人。
email	否	String	审核人邮箱。
msg	否	String	审核信息。
directory_path	否	String	目录树。

表4 BizVersionManageVO
参数	是否必选	参数类型	描述
id	否	String	ID信息，填写String类型替代Long类型。
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_id	否	String	业务ID，填写String类型替代Long类型。
biz_info	否	String	业务对象信息。
status	否	String	实体的发布状态，只读，创建和更新时无需填写。枚举值： DRAFT: 草稿 PUBLISH_DEVELOPING: 发布待审核 PUBLISHED: 已发布 OFFLINE_DEVELOPING: 下线待审核 OFFLINE: 已下线 REJECT: 已驳回

表5 MetricMonitorVO
参数	是否必选	参数类型	描述
id	否	String	编码，填写String类型替代Long类型。
other_metric_ids	否	Array of strings	其他指标ID，填写String类型替代Long类型。
other_compound_metric_ids	否	Array of strings	其他复合指标ID。
expression	否	String	告警表达式。
metric_id	否	String	挂载指ID，填写String类型替代Long类型。
front_configs	否	String	前端表达式配置，用于前端数据恢复。
metric_type	否	String	挂载指标类型。

响应参数

状态码： 200

表6 响应Body参数
参数	参数类型	描述
data	data object	创建复合指标的返回结果，成功的个数。

表7 data
参数	参数类型	描述
value	CompoundMetricVO object	创建复合指标操作返回结果。

表8 CompoundMetricVO
参数	参数类型	描述
id	String	编码，填写String类型替代Long类型。
name_en	String	字段名。
name_ch	String	业务属性。
description	String	描述
dimension_group	String	颗粒度ID。
group_name	String	颗粒度名称，只读。
group_code	String	颗粒度编码，只读。
compound_type	String	复合指标类型。枚举值： EXPRESSION: 表达式 PERIODICITY_VALUED_COMPARISON: 环比 INTERVAL_VALUED_COMPARISON: 同比
comparison_type	String	比较类型。枚举值： YEAR_TO_YEAR: 年同比 MONTH_TO_MONTH: 月同比 WEEK_TO_WEEK: 周同比
metric_ids	Array of strings	指标信息，填写String类型替代Long类型。
metric_names	Array of strings	指标名称信息。
compound_metric_ids	Array of strings	复合指标信息，填写String类型替代Long类型。
compound_metric_names	Array of strings	复合指标名称信息
cal_fn_ids	Array of strings	引用函数ID，填写String类型替代Long类型。
cal_exp	String	计算表达式，形如${index_id} + ${compound#index_id}，其中index_id代表引用的衍生指标ID，compound#index_id代表引用的复合指标ID。
l1_id	String	主题域分组ID，只读，填写String类型替代Long类型。
l2_id	String	主题域ID。
l3_id	String	业务对象ID，填写String类型替代Long类型。
data_type	String	字段类型。
create_by	String	创建人。
update_by	String	更新人。
status	String	实体的发布状态，只读，创建和更新时无需填写。枚举值： DRAFT: 草稿 PUBLISH_DEVELOPING: 发布待审核 PUBLISHED: 已发布 OFFLINE_DEVELOPING: 下线待审核 OFFLINE: 已下线 REJECT: 已驳回
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，只读，填写String类型替代Long类型。

表9 ApprovalVO
参数	参数类型	描述
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	业务实体类型。枚举值： 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	序列化之后的业务详情，类型是string。
biz_info_obj	Object	业务详情，类型是object。
biz_version	Integer	业务版本。
biz_status	String	实体的发布状态，只读，创建和更新时无需填写。枚举值： DRAFT: 草稿 PUBLISH_DEVELOPING: 发布待审核 PUBLISHED: 已发布 OFFLINE_DEVELOPING: 下线待审核 OFFLINE: 已下线 REJECT: 已驳回
approval_status	String	业务审批状态，只读。枚举值： DEVELOPING: 审核中 APPROVED: 审核通过 REJECT: 审核驳回 WITHDREW: 审核撤销
approval_type	String	业务审核类型。枚举值： PUBLISH: 发布 OFFLINE: 下线
submit_time	String	提交时间。
create_by	String	创建者。
l1	String	主题域分组中文名，只读，创建和更新时无需填写。
l2	String	主题域中文名，只读，创建和更新时无需填写。
l3	String	业务对象中文名，只读，创建和更新时无需填写。
approval_time	String	审核时间。
approver	String	审核人。
email	String	审核人邮箱。
msg	String	审核信息。
directory_path	String	目录树。

**表10** BizVersionManageVO
参数	参数类型	描述
id	String	ID信息，填写String类型替代Long类型。
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_id	String	业务ID，填写String类型替代Long类型。
biz_info	String	业务对象信息。
status	String	实体的发布状态，只读，创建和更新时无需填写。枚举值： DRAFT: 草稿 PUBLISH_DEVELOPING: 发布待审核 PUBLISHED: 已发布 OFFLINE_DEVELOPING: 下线待审核 OFFLINE: 已下线 REJECT: 已驳回
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。

**表11** MetricMonitorVO
参数	参数类型	描述
id	String	编码，填写String类型替代Long类型。
other_metric_ids	Array of strings	其他指标ID，填写String类型替代Long类型。
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，填写String类型替代Long类型。
front_configs	String	前端表达式配置，用于前端数据恢复。
metric_type	String	挂载指标类型。

状态码： 400

**表12** 响应Body参数
参数	参数类型	描述
error_code	String	错误码，如DS.6000，请求处理失败。
error_msg	String	错误信息。
data	Object	返回的数据信息。

状态码： 401

**表13** 响应Body参数
参数	参数类型	描述
error_code	String	错误码，如DS.6000，请求处理失败。
error_msg	String	错误信息。
data	Object	返回的数据信息。

状态码： 403

**表14** 响应Body参数
参数	参数类型	描述
error_code	String	错误码，如DS.6000，请求处理失败。
error_msg	String	错误信息。
data	Object	返回的数据信息。

请求示例

根据下列参数，新建复合指标。

POST https://{endpoint}/v2/{project_id}/design/compound-metrics

{
  "id" : 0,
  "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" : null,
    "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

父主题：复合指标接口

上一篇：查找复合指标

下一篇：更新复合指标

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问

新建复合指标

功能介绍

调用方法

URI

请求参数

响应参数

请求示例

响应示例

状态码

相关文档

意见反馈

文档内容是否对您有帮助？

7*24

备案

专业服务

退订

建议反馈

售前咨询热线