文档首页/ 数据治理中心 DataArts Studio/ API参考/ 数据架构API/ 衍生指标接口/ 查看衍生指标详情

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

在线调试

CLI示例

查看PDF

查看衍生指标详情

功能介绍

通过ID获取衍生详情信息。

调用方法

请参见如何调用API。

URI

GET /v2/{project_id}/design/derivative-indexs/{id}

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

表2 Query参数
参数	是否必选	参数类型	描述
latest	否	Boolean	是否查询最新的。

请求参数

表3 请求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

表4 响应Body参数
参数	参数类型	描述
data	data object	返回数据。

表5 data
参数	参数类型	描述
value	DerivativeIndexVO object	返回的数据信息。

表6 DerivativeIndexVO
参数	参数类型	描述
id	String	衍生指标ID，ID字符串。更新时必填。
name_en	String	衍生指标英文名称。
name_ch	String	衍生指标名称。
description	String	描述，只读。
create_by	String	创建人。
data_type	String	字段类型。
l1_id	String	主题域分组ID，只读，ID字符串。
l2_id	String	主题域ID。
l3_id	String	业务对象guid，ID字符串。
status	String	实体的发布状态，只读，创建和更新时无需填写。枚举值： DRAFT: 草稿 PUBLISH_DEVELOPING: 发布待审核 PUBLISHED: 已发布 OFFLINE_DEVELOPING: 下线待审核 OFFLINE: 已下线 REJECT: 已驳回
atomic_index_id	String	原子指标ID，ID字符串。
time_condition_id	String	时间限定ID，ID字符串。
time_field_id	String	时间限定关联字段ID，ID字符串。
time_field_name	String	时间限定关联字段名称，只读。
common_conditions	Array of CommonConditionVO objects	通用限定信息。
dimension_groups	Array of DerivativeIndexDimensionVO objects	统计维度，更新时不可修改。
monitor	MetricMonitorVO object	指标监控。
atomic_index	AtomicIndexVO object	原子指标信息，名称、单位，只读。
time_condition_name	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。
l1	String	主题域分组中文名，只读，创建和更新时无需填写。
l2	String	主题域中文名，只读，创建和更新时无需填写。
l3	String	业务对象中文名，只读，创建和更新时无需填写。
summary_table_id	String	汇总表ID，只读，ID字符串。
approval_info	ApprovalVO object	审批信息,只读参数。业务对象最近一次的审批信息，包括审批的业务详情、审核人信息、审核时间等。
new_biz	BizVersionManageVO object	业务版本管理，只读。

表7 CommonConditionVO
参数	参数类型	描述
name	String	名称。
field_ids	Array of strings	字段id信息，格式：table_id.field_id。
field_names	Array of strings	字段名称信息，格式：表名称.字段名称。
cal_exp	String	计算表达式，形如'${table_id.column_id} > 1'，其中table_id表示引用字段所属表ID，column_id表示引用字段ID。
cal_fn_ids	Array of strings	引用函数ID，ID字符串。
front_configs	String	前端表达式配置，用于前端数据恢复。
id	String	通用限定ID，只读，ID字符串。

表8 DerivativeIndexDimensionVO
参数	参数类型	描述
group_id	String	维度分组ID。
role	String	维度角色。
dimension_id	String	维度ID，ID字符串。
hierarchies_id	String	维度层级ID，ID字符串。
ordinal	Integer	序号，只读。
group_name	String	维度分组名称。
group_code	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: 时间限定
hierarchies	Array of DimensionHierarchiesVO objects	层级属性，只读。
l1	String	主题域分组，只读。
l2	String	主题域，只读。
l3	String	业务对象，只读。
l1_id	String	主题域分组ID，只读，ID字符串。
l2_id	String	主题域ID。
l3_id	String	业务对象ID，只读，ID字符串。
dw_type	String	数据连接类型。
id	String	层级的ID，只读，ID字符串。

表9 DimensionHierarchiesVO
参数	参数类型	描述
id	String	编码，ID字符串。
name	String	层级名称。
attrs	Array of HierarchiesAttrVO objects	层级包含的属性。
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。
create_by	String	创建人。
update_by	String	更新人。

**表10** HierarchiesAttrVO
参数	参数类型	描述
id	String	编码，ID字符串。
hierarchies_id	String	层级ID，ID字符串。
attr_id	String	属性ID，ID字符串。
level	Integer	层次。
attr_name_en	String	引用属性编码。
attr_name_ch	String	引用属性名称，只读。
detail_attr_ids	Array of strings	详情属性ID，ID字符串。
detail_attr_name_ens	Array of strings	详情属性英文。
detail_attr_name_chs	Array of strings	详情属性中文，只读。
attr	DimensionAttributeVO object	引用属性字段，只读。
detail_attrs	Array of DimensionAttributeVO objects	详情字段，只读。

**表11** DimensionAttributeVO
参数	参数类型	描述
id	String	编码，ID字符串。
dimension_id	String	维度ID，只读，ID字符串。
code_table_field_id	String	码表属性ID，ID字符串。
name_en	String	字段名。
name_ch	String	业务属性。
description	String	描述。
create_by	String	创建人。
data_type	String	字段类型。
domain_type	String	字段类型所属域。枚举值： NUMBER: 数字类型 STRING: 字符类型 DATETIME: 日期类型 BLOB: 大对象(BLOB) OTHER: 其它类型
data_type_extend	String	数据类型扩展字段。
is_primary_key	Boolean	是否主键。
is_biz_primary	Boolean	是否业务主键。
is_partition_key	Boolean	是否分区。
ordinal	Integer	序号。
not_null	Boolean	是否不为空。
stand_row_id	String	关联的数据标准的ID，ID字符串。
stand_row_name	String	关联的数据标准名称，只读。
quality_infos	Array of QualityInfoVO objects	质量信息，只读。
secrecy_levels	Array of SecrecyLevelVO objects	密级
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。
alias	String	别名
self_defined_fields	Array of SelfDefinedFieldVO objects	自定义项。

**表12** QualityInfoVO
参数	参数类型	描述
id	String	编码ID，ID字符串。
table_id	String	表ID，只读，ID字符串。
attr_id	String	属性ID，只读，ID字符串。
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: 时间限定
data_quality_id	String	质量ID，ID字符串。
show_control	Integer	是否要显示正则表达式。
data_quality_name	String	质量名称。
alert_conf	String	告警配置。
expression	String	正则相关校验规则中正则配置。
extend_info	String	扩展信息。
from_standard	Boolean	是否来源于数据标准质量配置，只读。
result_description	String	结果说明。
create_by	String	创建人，只读。
update_by	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。

**表13** SecrecyLevelVO
参数	参数类型	描述
id	String	密级ID，ID字符串。
uuid	String	数据安全主键。
name	String	密级名。
slevel	Integer	密级等级。
description	String	密级描述。
create_by	String	创建人。
update_by	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。
new_biz	BizVersionManageVO object	业务版本管理，只读。

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

**表15** MetricMonitorVO
参数	参数类型	描述
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	挂载指标类型。

**表16** AtomicIndexVO
参数	参数类型	描述
id	String	编码，ID字符串。
name_en	String	原子指标英文名。
name_ch	String	原子指标英文名。
description	String	描述。
create_by	String	创建人。
cal_exp	String	计算表达式，形如'sum(${fact_column_id})'，其中fact_column_id表示引用事实表中的字段ID。
cal_fn_ids	Array of strings	引用函数ID，ID字符串。
l1_id	String	主题域分组ID，只读，ID字符串。
l2_id	String	主题域ID。
l3_id	String	业务对象guid，ID字符串。
table_id	String	事实表ID，ID字符串。
tb_name	String	事实表名称。
dw_type	String	数据连接类型，只读。
field_ids	Array of strings	字段ID信息，ID字符串。
field_names	Array of strings	字段名称信息。
status	String	实体的发布状态，只读，创建和更新时无需填写。枚举值： DRAFT: 草稿 PUBLISH_DEVELOPING: 发布待审核 PUBLISHED: 已发布 OFFLINE_DEVELOPING: 下线待审核 OFFLINE: 已下线 REJECT: 已驳回
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: 时间限定
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	业务对象中文名，只读，创建和更新时无需填写。
approval_info	ApprovalVO object	审批信息,只读参数。业务对象最近一次的审批信息，包括审批的业务详情、审核人信息、审核时间等。
new_biz	BizVersionManageVO object	业务版本管理，只读。

**表17** ApprovalVO
参数	参数类型	描述
id	String	审批单ID，ID字符串。
tenant_id	String	项目ID，获取方式参考接口路径参数“project_id”。
name_ch	String	业务中文名。
name_en	String	业务英文名。
biz_id	String	业务ID，ID字符串。
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	目录树。

**表18** BizVersionManageVO
参数	参数类型	描述
id	String	ID信息，ID字符串。
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，ID字符串。
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。

状态码： 400

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

状态码： 401

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

状态码： 403

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

请求示例

根据衍生指标ID，获取衍生指标详情。

GET https://{endpoint}/v2/{project_id}/design/derivative-indexs/1181167466668310528

响应示例

状态码： 200

Success，返回data数据是DerivativeIndexVO详情。

{
  "data" : {
    "value" : {
      "id" : "1181167466668310528",
      "name_en" : "sum_total_amount",
      "name_ch" : "总车费(供应商)",
      "description" : "",
      "create_by" : "test_uesr",
      "data_type" : "STRING",
      "l1_id" : "1170066794946420736",
      "l2_id" : null,
      "l3_id" : null,
      "status" : "PUBLISHED",
      "atomic_index_id" : "1170005876631875584",
      "time_condition_id" : null,
      "time_field_id" : null,
      "time_field_name" : null,
      "common_conditions" : [ ],
      "dimension_groups" : [ {
        "group_id" : "1169322847009742848",
        "role" : null,
        "dimension_id" : "1169322847009742848",
        "hierarchies_id" : null,
        "ordinal" : 1,
        "group_name" : "供应商",
        "group_code" : "dim_vendor",
        "biz_type" : "DIMENSION",
        "hierarchies" : null,
        "l1" : null,
        "l2" : null,
        "l3" : null,
        "l1_id" : null,
        "l2_id" : null,
        "l3_id" : null,
        "dw_type" : null,
        "id" : "1181167466768973824"
      } ],
      "monitor" : null,
      "atomic_index" : {
        "id" : "1170005876631875584",
        "name_en" : "sum_total_amount",
        "name_ch" : "总车费",
        "description" : "",
        "create_by" : null,
        "cal_exp" : "sum(总车费) ",
        "cal_fn_ids" : null,
        "l1_id" : null,
        "l2_id" : null,
        "l3_id" : null,
        "table_id" : "1169329693619625984",
        "tb_name" : null,
        "dw_type" : null,
        "field_ids" : [ ],
        "field_names" : null,
        "status" : "DRAFT",
        "biz_type" : "FACT_LOGIC_TABLE",
        "create_time" : "2024-04-20T16:15:41.487+08:00",
        "update_time" : "2024-04-20T16:15:41.487+08:00",
        "l1" : null,
        "l2" : null,
        "l3" : null,
        "approval_info" : null,
        "new_biz" : null
      },
      "time_condition_name" : null,
      "create_time" : "2023-12-04T09:37:49+08:00",
      "update_time" : "2023-12-04T09:37:49+08:00",
      "l1" : "test_001",
      "l2" : null,
      "l3" : null,
      "summary_table_id" : "1181167468975177728",
      "approval_info" : {
        "id" : "1181167467817549824",
        "tenant_id" : null,
        "name_ch" : null,
        "name_en" : null,
        "biz_id" : "1181167466668310528",
        "biz_type" : null,
        "biz_info" : null,
        "biz_info_obj" : null,
        "biz_version" : 0,
        "biz_status" : "PUBLISHED",
        "approval_status" : "APPROVED",
        "approval_type" : null,
        "submit_time" : "2023-12-04T09:37:49+08:00",
        "create_by" : null,
        "l1" : null,
        "l2" : null,
        "l3" : null,
        "approval_time" : "2023-12-04T09:37:49+08:00",
        "approver" : "test_uesr",
        "email" : null,
        "msg" : "Fast Approval OK.",
        "directory_path" : null
      },
      "new_biz" : 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代码示例如下。

      
       
         
         
           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 ShowDerivativeIndexByIdSolution {

    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();
        ShowDerivativeIndexByIdRequest request = new ShowDerivativeIndexByIdRequest();
        request.withId("{id}");
        try {
            ShowDerivativeIndexByIdResponse response = client.showDerivativeIndexById(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 = ShowDerivativeIndexByIdRequest()
        request.id = "{id}"
        response = client.show_derivative_index_by_id(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.ShowDerivativeIndexByIdRequest{}
	request.Id = "{id}"
	response, err := client.ShowDerivativeIndexById(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

          

        

      
     

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

状态码

状态码	描述
200	Success，返回data数据是DerivativeIndexVO详情。
400	BadRequest
401	Unauthorized
403	Forbidden

父主题：衍生指标接口

上一篇：删除衍生指标

下一篇：复合指标接口

意见反馈

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

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

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

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

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

字符长度不能超过500

直接提交取消