orgId |
Mandatory |
String |
The organization ID which the metric belongs to. |
mdmIds |
Mandatory |
String |
The object instance ID which the metric belongs to. Separate multiple IDs by commas. Format: mdmId1,mdmId2,mdmId3,mdmId4; format with aggregation groups: mdmId1,mdmId2:group1|mdmId3,mdmId4:group2. |
metrics |
Mandatory |
String |
The metric ID. Separate multiple IDs by commas. |
timeGroup |
Mandatory |
String |
The time granularity by which the metric is aggregated. The following granularity are supported: RAW (raw data), 1m (1 minute), 5m (5 minutes), 10m (10 minutes), 15m (15 minutes), 30m (30 minutes), 60m (60 minutes), H (hour), D (day), W (week), M (month), Y (year), T (total), L (Latest). |
startTime |
Optional if timeGroup is L, otherwise mandatory |
String |
The start time of the sampling data. Format: YYYY-MM-dd hh:mm:ss. |
endTime |
Optional if timeGroup is L, otherwise mandatory |
String |
The end time of the sampling data. Its format must be consistent with startTime. |
dimensions |
Optional |
String |
The dimension other than asset and time, such as device type and device manufacturer. |
rollup |
Optional |
Boolean |
Whether to roll up data for queries by multiple dimensions. |
rollupDimensions |
Optional |
String |
The rollup dimension for queries by multiple dimensions. If blank, the value of dimensions is used. |
withDimensionName |
Optional |
Boolean |
Whether to include the dimension name when returning a dimension ID for UI display. If true, the returned dimension name should be in this format: {dimensionId}Name, for example, API providers should return alertRuleName for the alertRule dimension. |
locale |
Optional |
String |
Use zh-CN, en-US, ja-JP, or es-ES. If not specified, the value is set to en_US by default. |
filter |
Optional |
String |
Filter the returned data based on the expression. For example, [[{“field”:”field1”,”operator”:”>=”,”value”:”1”},{“field”:”field2”,”operator”:”<=”,”value”:”2”}],[{“field”:”field3”,”operator”:”==”,”value”:”3”}]], which means the returned data is filtered by (field1 >= 1 and field2 <= 2) or (field3=3). |
orderBy |
Optional |
String |
Sort the returned data based on the expression. For example, [{“field”:”field1”,”order”:”ASC”}, {“field”:”field2”,”order”:”DESC”}], which means the returned data is sorted first by field1 in ascending order and then by field2 in descending order. |
pageSize |
Optional |
Integer |
The number of the returned records on a single page. |
pageNo |
Optional |
Integer |
The number of page to be returned. The default value is 1. |
virtualDimensions |
Optional |
String |
A self-defined dimension to replace the dimensions parameter. |