注册标准指标


注册标准指标是对通用数据服务 API 最终暴露出去的指标进行解释的过程。只有先在通用数据服务上注册标准指标，才能通过通用数据服务 API 查询使用这些指标。应用构建者可以通过上传模板文件批量注册标准指标。

备注

标准指标是通用数据服务 API 直接提供的指标查询对象。

前提条件


开始之前，确保当前帐号已被分配所需的资产权限、操作权限点和包含 标准指标 在内的菜单组。如未分配，联系应用管理员。

操作步骤


  1. 在左侧导航栏中选择 元数据 > 标准指标。

  2. 根据目标指标的生效范围选择 公有指标 或 私有指标 标签页，点击 导入。有关公有/私有指标的区别，参见 公有/私有指标。

  3. 在弹窗中点击 下载模板，选择下载 Excel 或 JSON 模板文件。

  4. 参考以下信息填写模板文件。


    字段名称

    标识符

    必填/选填

    描述

    指标标识符

    metricKey

    必填

    指标的唯一标识符，需保证在同一作用域（公有/私有）内的同一对象类型下的唯一性。标准格式：<组织缩写前缀>.<指标英文名称><同环比标识符>:<二级指标维度>。更多信息，参见 标准指标标识符规则。

    指标中文/英文/日语/西班牙语名称

    metricNameZh/En/Ja/Es

    中文和英文为必填

    不同语言的指标名称。

    对象类型标识符

    mdmType

    必填

    指标对应的对象类型的标识符。可前往 元数据 > 对象类型 查看对应对象类型的标识符。

    对象类型名称

    mdmTypeName

    选填

    指标对应的对象类型的名称。可前往 元数据 > 对象类型 查看对应对象类型的名称。

    查询间隔

    interval

    选填

    指标支持的查询间隔，与对应的原始指标保持一致。目前支持的查询间隔：L（最新数据），15m（15 分钟），30m（30 分钟），H（小时），D（日），W（周），M（月），Q（季），Y（年），T（总计）。多个查询间隔之间用英文逗号隔开，例如：D,W,M,Y,T。

    聚合方式

    mdmAggMethods

    选填

    多对象查询时支持的指标聚合方式，如果不填则基于原始指标各自先聚合后再做表达式计算。例如：传入一组光伏电站 ID，查询汇总的发电量指标时，系统将返回多光伏电站的发电量之和（sum）。目前支持的聚合方式：sum，avg，max，min。

    是否虚拟指标

    isCalculated

    选填

    若为透传指标，填写 N；若为虚拟指标，填写 Y（公式在“指标表达式”中定义）。有关透传/虚拟指标的区别，参见 透传/虚拟指标 。

    指标表达式

    expression

    必填

    若为透传指标，指标表达式为 原始指标APIKey@@原始指标字段Key，例如 WindAPI@@SENL_METER_REPORT.APREVERSE_DELTA；若为虚拟指标，基于 Spring 表达式填写指标表达式，更多信息，参见 注册虚拟指标。

    枚举量

    enumerate

    选填

    若为枚举类型的指标，填写支持的枚举量。

    单位

    units

    选填

    指标数值的单位，参考 EnOS 内置单位 填写。

    数据类型

    dataType

    必填

    指标数值的数据类型。目前支持的数据类型：Int，Double，String。

    是否可排序

    sortable

    选填

    若查询指标时可以按升/降序返回结果，则填写 Y；若不可排序，填写 N。

    筛选器

    filters

    选填

    查询指标时支持的筛选方式。目前支持的筛选方式：in，==，!=，>，>=，<，<=。多个筛选方式之间用英文逗号分隔，例如：==,in。

    标准类型

    standardType

    选填

    填写 standard 或 illegal 标记指标是否合规。不合规指标代表标识符未经过标准化，在数据消费时建议使用合规（standard）的指标。

    关联的一级指标

    passMetric

    选填

    如果当前指标为二级指标，则填写对应的一级指标标识符；不填则代表当前指标为一级指标。

    二级指标维度

    period

    选填

    如果当前指标为二级指标，填写其二级指标维度的标识符，例如：L，TD，MTD 等。有关各标识符的具体含义，参见 注册二级指标。

    指标描述中文/英文/日文/西班牙语

    metricDescriptionZh/En/Ja/Es

    选填

    不同语言的指标描述。

    聚合维度

    dimensions

    选填

    支持的指标查询聚合维度的标识符，多个聚合维度之间用英文逗号分隔。例如：光伏电站的 等效利用小时 指标支持按电站类型或其下的逆变器机型聚合查询，那么查询结果将会按电站类型或逆变机型返回结果。可前往 元数据 > 维度类型 查看对应维度类型的标识符。

    关联应用

    applicationDependency

    选填

    指标依赖部署的应用，多个应用之间用英文逗号分隔。

    关联应用依赖版本

    applicationVersionDependency

    选填

    指标依赖部署的应用版本，多个版本之间用英文逗号分隔。


    备注

    导入模板中的“所属组织标识符”、“所属组织名称”、“关联数据源”、“更新时间”和“操作人”字段无需填写，将在上传后由系统自动填充。其中，“关联数据源”由系统根据“指标表达式”中引用的原始指标所关联的数据源进行填充，多个数据源由英文逗号隔开。

  5. 在弹窗中点击 上传。选择填写后的模板文件并点击 确定。

结果


注册成功后，标准指标出现在指标列表中。应用构建者可以查看指标详情，并进行以下操作：

  • 修改标准指标：点击 导出，按需修改下载的文件后再导入新文件。标识符相同的指标会覆盖原有指标，不同则新增指标。

  • 删除标准指标：点击对应指标行的 删除 Delete 。指标删除后不可恢复。