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。 | 
返回内容类型¶
application/json; charset = UTF-8
返回码¶
参见 通用数据服务 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"
}