Query Meta Metric¶

根据对象类型标识符等信息获取指标元数据。

请求格式¶

GET https://{api-gateway}/cds-meta-service/v1.0/metric?action=query

请求参数¶

名称	位置	必需/可选	数据类型	描述
orgId	Query	必需	String	指标所属的组织 ID。如何获取 orgId 信息>>
mdmTypes	Query	必需	String	指标所属的对象类型的标识符，多个对象类型之间用英文逗号隔开。单次查询指定的对象类型数量不超过 100。如何获取 mdmTypes 信息>>
locale	Query	可选	String	中文：zh-CN, 英文：en-US, 日语：ja-JP，西班牙语：es-ES。默认为 en-US。
withI18n	Query	可选	Boolean	是否返回完整的国际化内容，`true` 为返回，`false` 为不返回。默认不返回。
withDataSourceInfo	Query	可选	Boolean	是否返回数据源信息。默认不返回。
withElementGroupInfo	Query	可选	Boolean	是否返回可视化分组信息。默认返回。
withSourceMetric	Query	可选	Boolean	是否返回原始指标元数据。默认不返回。若返回原始指标元数据，需确保所需原始指标已开放查询。
withDescription	Query	可选	Boolean	是否返回指标描述。默认不返回。

返回内容类型¶

application/json; charset = UTF-8

响应参数 ¶

名称	必然/可能返回	数据类型	描述
mdmType	必然返回	String	指标所属的对象类型。
metric	必然返回	String	指标的标识符。
name	必然返回	String	请求语言中指标的名称。
nameI18n	可能返回	I18n 结构体	描述指标的国际化名称。参见 I18n 结构体。
description	可能返回	String	请求语言中指标的描述。
descriptionI18n	可能返回	I18n 结构体	指标的国际化描述。
type	必然返回	String	指标的数据类型。
units	可能返回	String	指标的单位。
expression	可能返回	String	指标的表达式。
mdmAggMethods	可能返回	String	指标的对象类型聚合方式。
interval	必然返回	String	指标支持的查询间隔，例如 D、M、Y。
period	可能返回	String	二级指标的时间维度，例如 TD、MTD、YTD。
passMetric	可能返回	String	二级指标对应的一级指标的标识符。
groups	可能返回	Map（Key 为 String，Value 为 Group 结构体）	指标的可视化分组信息。参见 Group 结构体。
enumerate	可能返回	Map（Key 为 String，Value 为 Enumerate 结构体）	枚举类指标的枚举值。参见 Enumerate 结构体。
dimensions	可能返回	String	指标支持的查询聚合维度。
standardType	可能返回	String	指标的标准类型，标记指标是否经过标准化、是否合规。
filters	可能返回	String	指标支持的筛选方式。
sortable	可能返回	Boolean	指标是否可排序。
datasources	可能返回	String	指标的数据源。
dataSourceCapability	可能返回	String	指标的数据源支持的能力，例如分页、指标筛选、指标排序等。

I18n 结构体 ¶

名称	必然/可能返回	数据类型	描述
defaultValue	必然返回	String	默认内容。
en_US	可能返回	String	英文内容。
zh_CN	可能返回	String	中文内容。
es_ES	可能返回	String	西班牙语内容。
ja_JP	可能返回	String	日语内容。

Group 结构体 ¶

名称	必然/可能返回	数据类型	描述
groupName	必然返回	String	请求语言中可视化分组的名称。
groupNameI18n	可能返回	I18n 结构体	描述可视化分组的国际化名称。参见 I18n 结构体。
groupOrder	必然返回	Integer	可视化分组的顺序。
elementName	必然返回	String	请求语言中可视化分组内元素的名称。
elementNameI18n	可能返回	I18n 结构体	描述元素的国际化名称。参见 I18n 结构体。
elementOrder	必然返回	Integer	可视化分组内元素的顺序。
area	必然返回	Map（Key 为 String，Value 为 Area 结构体）	可视化分组内的分类信息。参见 Area 结构体。

Area 结构体 ¶

名称	必然/可能返回	数据类型	描述
areaName	必然返回	String	请求语言中分类的名称。
areaNameI18n	可能返回	I18n 结构体	描述分类的国际化名称。参见 I18n 结构体。
areaOrder	必然返回	Integer	分类的顺序。

Enumerate 结构体 ¶

名称	必然/可能返回	数据类型	描述
name	必然返回	String	请求语言中枚举值的名称。
nameI18n	可能返回	I18n 结构体	描枚举值的国际化名称。参见 I18n 结构体。

返回码¶

参见通用数据服务 API 返回码。

示例¶

请求示例¶

GET https://{api-gateway}/cds-meta-service/v1.0/metric?action=query&orgId=yourOrgId&mdmTypes=yourMdmType

返回示例¶

{
   "data":[
        {
            "mdmType":"yourMdmType",
            "metric": "activeProduction",
            "name": "Active Production",
            "units": "kWh",
            "type": "Double",
            "interval": "D,M,Y,T",
            "mdmAggMethods": "sum",
            "accumulativePoint": "SITE.ActiveProduction",
            "dimensions": "inverterModel,inverterMfr",
            "dataSources": "SolarAPI,OLAPAPI"
        },
        {
            "mdmType":"yourMdmType",
            "metric": "PlannedCompRate",
            "name": "Plan Completion Rate",
            "units": "%",
            "type": "Double",
            "interval": "D,M,Y,T",
            "mdmAggMethods": "--",
            "groups": {
                "Mobile_Metric_Tool": {
                    "groupName": "移动端指标对比",
                    "groupNameI18n": {
                        "defaultValue": "移动端指标对比",
                        "i18nValue": {}
                    },
                    "groupOrder": 12,
                    "elementName": "Planned Complete Rate",
                    "elementNameI18n": {
                        "defaultValue": "计划完成率",
                        "i18nValue": {
                            "en_US": "Planned Complete Rate",
                            "zh_CN": "计划完成率"
                        }
                    },
                    "elementOrder": 11,
                    "area": {
                        "Mobile_Metric_Tool_4": {
                            "areaName": "电量",
                            "areaNameI18n": {
                                "defaultValue": "电量",
                                "i18nValue": {}
                            },
                            "areaOrder": 4
                        }
                    }
                },
                "CT_Metric": {
                    "groupName": "曲线工具",
                    "groupNameI18n": {
                        "defaultValue": "曲线工具",
                        "i18nValue": {}
                    },
                    "groupOrder": 7,
                    "elementName": "Planned Complete Rate",
                    "elementNameI18n": {
                        "defaultValue": "完成率",
                        "i18nValue": {
                            "en_US": "Planned Complete Rate",
                            "zh_CN": "完成率"
                        }
                    },
                    "elementOrder": 3,
                    "area": {
                        "CT_Metric1": {
                            "areaName": "指标",
                            "areaNameI18n": {
                                "defaultValue": "指标",
                                "i18nValue": {}
                            },
                            "areaOrder": 2
                        }
                    }
                }
            },
           "enumerate": {
                "yourEnumValue": {
                    "nameI18n": {
                        "defaultValue": "yourEnumValue",
                        "i18nValue": {}
                    },
                    "name": "yourEnumValue"
                },
                "yourEnumValue": {
                    "nameI18n": {
                        "defaultValue": "yourEnumValue",
                        "i18nValue": {}
                    },
                    "name": "yourEnumValue"
                }
            }
        },
        {
            "mdmType":"yourMdmType",
            "metric": "SITE.PR",
            "name": "Performance Ratio",
            "units": "%",
            "type": "Double",
            "interval": "D,M,Y,T",
            "expression": "#{Metric['SITE.PR150_Numerator'] / Metric['SITE.PR150_Denominator']}",
            "standardType": "illegal",
            "filters": ">,>=",
            "sortable": false,
            "dataSources": "SolarAPI",
            "dataSourceCapability": {
                "dimensionFilter": "2",
                "pagination": "1",
                "mdmGroup": "1",
                "virtualDimension": "1",
                "dimensionSort": "2",
                "metricSort": "2",
                "metricFilter": "2",
                "rollup": "1"
            }
        }
   ],
   "code":0,
   "msg":"OK"
}