Query Latest Metric¶

根据指标标识符等信息获取最新的指标数据。

请求格式¶

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

请求参数¶

名称	位置	必需/可选	数据类型	描述
orgId	Query	必需	String	指标所属的组织 ID。如何获取 orgId 信息>>
mdmIds	Query/Form	必需	String	指标对应的对象实例的标识符，多个对象实例之间用英文逗号隔开。单次查询指定的对象实例数量不超过 20000。为保证查询性能，建议单次查询指定的对象实例数量不超过 100。
metrics	Query/Form	必需	String	指标的标识符，多个指标之间用英文逗号隔开。单次查询指定的指标数量不超过 100。如何获取 metrics 信息>>
dimensions	Query/Form	可选	String	除资产和时间之外的维度，例如：设备型号、设备制造商。该参数用于聚合查询或筛选，多个维度之间用英文逗号隔开。单次查询指定的维度数量不超过 10。如何获取 dimensions 信息>>
rollup	Query/Form	可选	Boolean	有额外维度时是否上钻。
rollupDimensions	Query/Form	可选	String	上钻的维度列表，置空则使用“dimensions”参数的值。
withDimensionName	Query/Form	可选	Boolean	在返回维度标识符时，是否同时返回维度名称。
locale	Query/Form	可选	String	中文：zh-CN, 英文：en-US, 日语：ja-JP，西班牙语：es-ES。默认为 en-US。
mdmTypes	Query/Form	可选	String	返回结果按照子资产所属的对象类型进行过滤，目前仅支持指定单个对象类型的标识符。如何获取 mdmTypes 信息>>
filter	Query/Form	可选	String	返回结果按 metrics 或 dimensions 进行过滤。例如：[[{“field”:”field1”,”operator”:”>=”,”value”:”1”},{“field”:”field2”,”operator”:”<=”,”value”:”2”}],[{“field”:”field3”,”operator”:”==”,”value”:”3”}]]，该表达式含义为：(field1 >= 1 and field2 <= 2) or (field3=3)。
orderBy	Query/Form	可选	String	返回结果按 metrics 或 dimensions 进行排序。例如：[{“field”:”field1”,”order”:”ASC”}, {“field”:”field2”,”order”:”DESC”}]，该表达式含义为：按 field1 升序进行一级排序，并按 field2 降序进行二级排序。
pageSize	Query/Form	可选	Integer	分页查询时单页返回记录的条数，最大值为 20000。
pageNo	Query/Form	可选	Integer	分页查询时指定页码，从 1 开始。

返回内容类型¶

application/json; charset = UTF-8

响应参数¶

名称	必然/可能返回	数据类型	描述
data	必然返回	LatestMetric 结构体	描述指标的信息。参见 LatestMetric 结构体。
pagination	必然返回	Pagination 结构体	描述分页信息。参见 Pagination 结构体。

LatestMetric 结构体 ¶

名称	必然/可能返回	数据类型	描述
metrics	可能返回	MetricValue 结构体	描述指标的实时数值。参见 MetricValue 结构体。
metricsWithDimensions	可能返回	MetricWithDimension 结构体	描述带维度的指标实时数值。参见 MetricWithDimension 结构体。

MetricValue 结构体 ¶

名称	必然/可能返回	数据类型	描述
value	必然返回	Integer/Double/String	指标的数值。
localtime	必然返回	String	指标数值对应的本地时间标记。

MetricWithDimension 结构体 ¶

名称	必然/可能返回	数据类型	描述
dimension	可能返回	Object	描述指标的维度信息。
metrics	必然返回	MetricValue 结构体	描述指标的实时数值。参见 MetricValue 结构体。

Pagination 结构体 ¶

名称	必然/可能返回	数据类型	描述
pageNo	必然返回	Integer	请求页数，从 1 开始。
pageSize	必然返回	Integer	每页的记录数。
totalSize	必然返回	Integer	记录总数。

返回码¶

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

示例¶

请求示例¶

GET https://{api-gateway}/cds-realtime-service/v1.0/metric/latest?action=query&orgId=yourOrgId&mdmIds=yourMdmId&metrics=yourMetrics

返回示例¶

{
    "data":{
        "yourMdmId":{
            "metrics":{
                "Production:TD":{
                    "value":0,
                    "localtime":"2021-06-04"
                },
                "Production:MTD":{
                    "value":29,
                    "localtime":"2021-06"
                },
                "Production:YTD":{
                    "value":282720,
                    "localtime":"2021"
                }
            },
            "metricsWithDimensions":[
                {
                    "dimension1":"yourDimension",
                    "metrics":{
                        "Production:TD":{
                            "value":0,
                            "localtime":"2021-06-04"
                        },
                        "Production:MTD":{
                            "value":29,
                            "localtime":"2021-06"
                        },
                        "Production:YTD":{
                            "value":282720,
                            "localtime":"2021"
                        }
                    }
                }
            ]
        }
    },
    "code":0,
    "msg":"OK",
    "traceId": "1234567890abcdefghijkl0987654321"
}