创建业务指标

功能介绍

创建业务指标。

调用方法

请参见如何调用API。

URI

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

表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体则无需填写和校验。

表3 请求Body参数
参数	是否必选	参数类型	描述
id	否	String	编码，更新时必填，创建时为空，填写String类型替代Long类型。
name	是	String	指标名称。
name_alias	否	String	指标别名。
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_catalog_id	是	String	归属的流程架构的ID，填写String类型替代Long类型。
data_origin	否	String	数据来源。
unit	否	String	计量单位。
time_filters	是	String	统计周期(时间限定)。
dimensions	否	String	统计维度。
general_filters	否	String	统计口径和修饰词。
interval_type	是	String	刷新频率。枚举值： MINUTE: 每分钟 HOUR: 每小时 DAY: 每天 WEEK: 每周 MONTH: 每月 YEAR: 每年 REAL_TIME: 实时 HALF_HOUR: 每半小时 QUART: 每15分钟 DOUBLE_WEEK: 每两周 HALF_YEAR: 每半年 HALF_DAY: 每半天
apply_scenario	否	String	应用场景。
technical_metric	否	String	关联技术指标，填写String类型替代Long类型。
technical_metric_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: 时间限定
measure	否	String	度量对象。
owner	是	String	指标责任人。
owner_department	是	String	指标管理部门。
destination	是	String	设置目的。
definition	是	String	指标定义。
expression	是	String	计算公式。
remark	否	String	备注。
approval_info	否	ApprovalVO object	审批信息,只读参数。业务对象最近一次的审批信息，包括审批的业务详情、审核人信息、审核时间等。
new_biz	否	BizVersionManageVO object	业务版本管理，只读。
l1	否	String	主题域分组中文名，只读，创建和更新时无需填写。
l2	否	String	主题域中文名，只读，创建和更新时无需填写。
l3	否	String	业务对象中文名，只读，创建和更新时无需填写。
self_defined_fields	否	Array of SelfDefinedFieldVO objects	自定义项

表4 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	目录树。

表5 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: 已驳回

表6 SelfDefinedFieldVO
参数	是否必选	参数类型	描述
fd_name_ch	否	String	自定义项中文名。
fd_name_en	否	String	自定义项英文名。
not_null	否	Boolean	是否必填。
fd_value	否	String	属性值。

响应参数

状态码： 200

表7 响应Body参数
参数	参数类型	描述
data	data object	data，统一的返回结果的最外层数据结构。

表8 data
参数	参数类型	描述
value	BizMetricVO object	value，统一的返回结果的外层数据结构。

表9 BizMetricVO
参数	参数类型	描述
id	String	编码，更新时必填，创建时为空，填写String类型替代Long类型。
name	String	指标名称。
code	String	指标编码，只读。
name_alias	String	指标别名。
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: 时间限定
status	String	实体的发布状态，只读，创建和更新时无需填写。枚举值： DRAFT: 草稿 PUBLISH_DEVELOPING: 发布待审核 PUBLISHED: 已发布 OFFLINE_DEVELOPING: 下线待审核 OFFLINE: 已下线 REJECT: 已驳回
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	刷新频率。枚举值： MINUTE: 每分钟 HOUR: 每小时 DAY: 每天 WEEK: 每周 MONTH: 每月 YEAR: 每年 REAL_TIME: 实时 HALF_HOUR: 每半小时 QUART: 每15分钟 DOUBLE_WEEK: 每两周 HALF_YEAR: 每半年 HALF_DAY: 每半天
apply_scenario	String	应用场景。
technical_metric	String	关联技术指标，填写String类型替代Long类型。
technical_metric_name	String	关联技术指标名称，只读。
technical_metric_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: 时间限定
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	自定义项

**表10** 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	目录树。

**表11** 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。

**表12** SelfDefinedFieldVO
参数	参数类型	描述
fd_name_ch	String	自定义项中文名。
fd_name_en	String	自定义项英文名。
not_null	Boolean	是否必填。
fd_value	String	属性值。

状态码： 400

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

状态码： 401

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

状态码： 403

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

请求示例

根据请求参数进行业务指标的创建。

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

{
  "code" : null,
  "biz_catalog_id" : "1200479561188536320",
  "name" : "test_create_biz_metrics",
  "name_alias" : "",
  "destination" : "业务人员对此业务指标的设置目的进行描述",
  "definition" : "比如：按月对数据库某张表的某个字段进行均值计算。",
  "expression" : "avg(table.column)",
  "data_origin" : "",
  "unit" : "",
  "time_filters" : "月度",
  "dimensions" : "test_czh_0305_001",
  "general_filters" : "",
  "interval_type" : "HOUR",
  "apply_scenario" : "",
  "technical_metric" : "",
  "measure" : "",
  "owner_department" : "data owner dept",
  "owner" : "test_uesr",
  "remark" : "该业务指标有啥需要注意的地方。",
  "self_defined_fields" : [ ]
}

响应示例

状态码： 200

Success，返回data数据是BizMetricVO。

{
  "data" : {
    "value" : {
      "id" : "1231249989901135872",
      "name" : "test_create_biz_metrics",
      "code" : "ZB000001",
      "name_alias" : "",
      "biz_type" : null,
      "status" : "DRAFT",
      "biz_catalog_id" : "1200479561188536320",
      "biz_catalog_path" : null,
      "create_by" : "test_uesr",
      "update_by" : "test_uesr",
      "data_origin" : "",
      "unit" : "",
      "time_filters" : "月度",
      "dimensions" : "test_czh_0305_001",
      "general_filters" : "",
      "interval_type" : "HOUR",
      "apply_scenario" : "",
      "technical_metric" : null,
      "technical_metric_name" : null,
      "technical_metric_type" : null,
      "measure" : "",
      "owner" : "test_uesr",
      "owner_department" : "data owner dept",
      "destination" : "业务人员对此业务指标的设置目的进行描述",
      "guid" : null,
      "definition" : "比如：按月对数据库某张表的某个字段进行均值计算。",
      "expression" : "avg(table.column)",
      "remark" : "该业务指标有啥需要注意的地方。",
      "approval_info" : null,
      "new_biz" : null,
      "create_time" : "2024-04-20T14:27:53.111+08:00",
      "update_time" : "2024-04-20T14:27:53.111+08:00",
      "l1" : null,
      "l2" : null,
      "l3" : null,
      "biz_metric" : null,
      "summary_status" : null,
      "self_defined_fields" : [ ]
    }
  }
}

状态码： 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代码示例如下。

根据请求参数进行业务指标的创建。

      
       
         
         
           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.*;

import java.util.List;
import java.util.ArrayList;

public class CreateBizMetricSolution {

    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();
        CreateBizMetricRequest request = new CreateBizMetricRequest();
        BizMetricVO body = new BizMetricVO();
        body.withRemark("该业务指标有啥需要注意的地方。");
        body.withExpression("avg(table.column)");
        body.withDefinition("比如:按月对数据库某张表的某个字段进行均值计算。");
        body.withDestination("业务人员对此业务指标的设置目的进行描述");
        body.withOwnerDepartment("data owner dept");
        body.withOwner("test_uesr");
        body.withMeasure("");
        body.withTechnicalMetric("");
        body.withApplyScenario("");
        body.withIntervalType(BizMetricVO.IntervalTypeEnum.fromValue("HOUR"));
        body.withGeneralFilters("");
        body.withDimensions("test_czh_0305_001");
        body.withTimeFilters("月度");
        body.withUnit("");
        body.withDataOrigin("");
        body.withBizCatalogId("1200479561188536320");
        body.withNameAlias("");
        body.withName("test_create_biz_metrics");
        request.withBody(body);
        try {
            CreateBizMetricResponse response = client.createBizMetric(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());
        }
    }
}

          

        

      
     

根据请求参数进行业务指标的创建。

      
       
         
         
           # 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 = CreateBizMetricRequest()
        request.body = BizMetricVO(
            remark="该业务指标有啥需要注意的地方。",
            expression="avg(table.column)",
            definition="比如:按月对数据库某张表的某个字段进行均值计算。",
            destination="业务人员对此业务指标的设置目的进行描述",
            owner_department="data owner dept",
            owner="test_uesr",
            measure="",
            technical_metric="",
            apply_scenario="",
            interval_type="HOUR",
            general_filters="",
            dimensions="test_czh_0305_001",
            time_filters="月度",
            unit="",
            data_origin="",
            biz_catalog_id="1200479561188536320",
            name_alias="",
            name="test_create_biz_metrics"
        )
        response = client.create_biz_metric(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

          

        

      
     

根据请求参数进行业务指标的创建。

      
       
         
         
           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.CreateBizMetricRequest{}
	remarkBizMetricVo:= "该业务指标有啥需要注意的地方。"
	measureBizMetricVo:= ""
	technicalMetricBizMetricVo:= ""
	applyScenarioBizMetricVo:= ""
	generalFiltersBizMetricVo:= ""
	dimensionsBizMetricVo:= "test_czh_0305_001"
	unitBizMetricVo:= ""
	dataOriginBizMetricVo:= ""
	nameAliasBizMetricVo:= ""
	request.Body = &model.BizMetricVo{
		Remark: &remarkBizMetricVo,
		Expression: "avg(table.column)",
		Definition: "比如:按月对数据库某张表的某个字段进行均值计算。",
		Destination: "业务人员对此业务指标的设置目的进行描述",
		OwnerDepartment: "data owner dept",
		Owner: "test_uesr",
		Measure: &measureBizMetricVo,
		TechnicalMetric: &technicalMetricBizMetricVo,
		ApplyScenario: &applyScenarioBizMetricVo,
		IntervalType: model.GetBizMetricVoIntervalTypeEnum().HOUR,
		GeneralFilters: &generalFiltersBizMetricVo,
		Dimensions: &dimensionsBizMetricVo,
		TimeFilters: "月度",
		Unit: &unitBizMetricVo,
		DataOrigin: &dataOriginBizMetricVo,
		BizCatalogId: "1200479561188536320",
		NameAlias: &nameAliasBizMetricVo,
		Name: "test_create_biz_metrics",
	}
	response, err := client.CreateBizMetric(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

          

        

      
     