Query Metric Data¶
用于批量查询指标数据。最多返回根据时间排序的前一万条数据。
使用 GET 方法¶
请求参数(URI)¶
名称 | 位置(Path/Query) | 必需/可选 | 数据类型 | 描述 |
---|---|---|---|---|
orgId | Query | 必需 | String | 用户所属的组织 ID。如何获取 orgId 信息>> |
metricIds | Query | 必需 | String | 所需查询的指标 ID。支持传入多个 ID,用逗号隔开。 |
startTime | Query | 可选 | String | 开始时间。时间格式为:yyyy-MM-dd HH:mm:ss
|
endTime | Query | 可选 | String | 结束时间。时间格式为:yyyy-MM-dd HH:mm:ss
|
mdmIds | Query | 可选 | String | 设备 ID。支持上传多个设备 ID,用逗号隔开。若参数为空,则默认查询所有设备。 |
extraFields | Query | 可选 | String | 查询的其他维度表属性。 |
valueEnum | Query | 可选 | Boolean | 查询的指标值的枚举信息。 |
format | Query | 可选 | Int | 查询结果返回格式。
|
示例¶
请求示例¶
url: https://{apigw-address}/metric-mgmt/v1.0/metricIds/data/normal?orgId=orgId&metricIds=metricId0,metricId1&startTime=2021-05-19 00:00:00&endTime=2021-05-21 00:00:00
method: GET
返回示例 ¶
当请求参数 format
值为 0
时,返回示例如下。
{
"msg": "OK",
"code": 0,
"data": [
{
"metricIdentifier":"MetricId0",
"value":[
{
"storage_active_electric": 2200.00,
"time": "2021-05-20",
"mdmId": "mdmId0"
},
{
"storage_active_electric": 100.00,
"time": "2021-05-20",
"mdmId": "mdmId1"
}
]
},
{
"metricIdentifier":"MetricId1",
"value":[
{
"storage_reactive_electric": 2200.00,
"time": "2021-05-20",
"mdmId": "mdmId0"
},
{
"storage_reactive_electric": 100.00,
"time": "2021-05-20",
"mdmId": "mdmId1"
}
]
}
]
}
当请求参数 format
值为 1
时,返回示例如下。
{
"msg": "OK",
"code": 0,
"data": [
{
"metricIdentifier": "MetricId0",
"mdmId": "mdmId0",
"value": [
{
"storage_active_electric": 2200.00,
"time": "2021-05-20"
},
{
"storage_active_electric": 100.00,
"time": "2021-05-20"
}
]
},
{
"metricIdentifier": "MetricId0",
"mdmId": "mdmId1",
"value": [
{
"storage_active_electric": 2200.00,
"time": "2021-05-20"
},
{
"storage_active_electric": 100.00,
"time": "2021-05-20"
}
]
},
{
"metricIdentifier": "MetricId1",
"mdmId": "mdmId0",
"value": [
{
"storage_reactive_electric": 2200.00,
"time": "2021-05-20"
},
{
"storage_reactive_electric": 100.00,
"time": "2021-05-20",
}
]
},
{
"metricIdentifier": "MetricId1",
"mdmId": "mdmId1",
"value": [
{
"storage_reactive_electric": 2200.00,
"time": "2021-05-20"
},
{
"storage_reactive_electric": 100.00,
"time": "2021-05-20"
}
]
}
]
}
当请求参数 format
值为 2
时,返回示例如下。
{
"msg": "OK",
"code": 0,
"data": [
{
"mdmId": "mdmId0",
"value":[
{
"MetricId0": 2200.00,
"MetricId1": 2200.00,
"time": "2021-05-20"
},
{
"MetricId0": 100.00,
"MetricId1": 100.00,
"time": "2021-05-21"
}
]
},
{
"mdmId": "mdmId1",
"value":[
{
"MetricId0": 2200.00,
"MetricId1": 2200.00,
"time": "2021-05-20"
},
{
"MetricId0": 100.00,
"MetricId1": 100.00,
"time": "2021-05-21"
}
]
}
]
}
使用 POST 方法¶
请求参数(Body)¶
名称 | 必需/可选 | 数据类型 | 描述 |
---|---|---|---|
orgId | 必需 | String | 用户所属的组织 ID。如何获取orgId信息>> |
metricIds | 必需 | String | 所需查询的指标 ID。支持传入多个 ID,用逗号隔开。 |
startTime | 可选 | String | 开始时间。时间格式为:yyyy-MM-dd HH:mm:ss
|
endTime | 可选 | String | 结束时间。时间格式为:yyyy-MM-dd HH:mm:ss
|
mdmIds | 可选 | String | 设备 ID。支持上传多个设备 ID,用逗号隔开。若参数为空,则默认查询所有设备。 |
extraFields | 可选 | String | 查询的其他维度表属性。 |
valueEnum | 可选 | Boolean | 查询的指标值的枚举信息。 |
format | 可选 | Int | 查询结果返回格式。
|