查询指标

接口描述

POST

/monitor/ts/data/v1/subscriptions/:subscription_name/resourceGroups/:resource_group_name/zones/:zone/telemetryStations/:telemetry_station_name/dashboards/:dashboard_name/panels/:panel_name/metrics

查询指标

请求头（Request Header）

参考认证（authentication）

请求参数（Request Parameters）

名称	类型	必须	位置	默认值	取值范围	描述
subscription_name	string	是	path	-	-	订阅
resource_group_name	string	是	path	-	-	资源组
zone	string	是	path	-	-	可用区
telemetry_station_name	string	是	path	-	-	监控空间
dashboard_name	string	否	query	-	-	仪表板名称
panel_name	string	否	query	-	-	仪表板名称

请求体（Request Body）

名称	类型	描述
start	int	开始时间
end	int	结束时间
step	int	指标间隔步长，秒（如60=1min，300=5min）。当获取的panel为即时值时，该参数无用；需满足(end-start)/step<11000
range_align	int	时间校准对齐，根据step，调整校准start，end time取整，默认false
query_filter	QueryFilter	查询过滤器

其中QueryFilter如下:

名称	类型	描述
resource_id	string	资源的资源管理器标识符
filters	map	筛选条件

请求示例（Request Example）

curl -XPOST  'https://monitor.sensecoreapi.tech/monitor/ts/data/v1/subscriptions/224bae0c-a98f-41f5-b5d3-9f54aa98455f/resourceGroups/default/zones/cn-sh-01z/telemetryStations/ts-user-a95a77a3-961f-43fa-9577-d5c8a2cb0149/dashboards/aec2_summery/panels/Aec2InfinibandTotal/metrics' \
  -H 'Content-Type: application/json' \
  -d '{
    "query_filter":
    {
        "resource_id":
        [
            "11043a95-f658-11ee-bb04-428fd376ea51"
        ],
        "filters":
        {}
    },
    "range_align": true,
    "start": 1712632270,
    "end": 1712661070,
    "step": 300
}'

响应（Response）

名称	类型	描述
metrics	[]MetricsResult	指标结果
start	int	开始时间
end	int	结束时间
step	int	指标间隔步长，秒（如60=1min，300=5min）。当获取的panel为即时值时，该参数无用；需满足(end-start)/step<11000
range_align	int	时间校准对齐，根据step，调整校准start，end time取整，默认false

其中，MetricsResult如下：

名称	类型	描述
metrics_attrs	map	指标属性
values	[]Values	指标值

其中，Values如下：

名称	类型	描述
metric_time	string	时间
values	float	值

响应示例（Response Example）

{
  "metrics_result": [
    {
      "metrics_attrs": {
        "__name__": "lepton__aec2_node_infiniband_port_data_transmitted_total__byte_per_s"
      },
      "values": [
        {
          "metric_time": "2024-04-09T10:05:00Z",
          "values": 5817.241
        },
        {
          "metric_time": "2024-04-09T10:10:00Z",
          "values": 5876.0566
        }
      ]
    },
    {
      "metrics_attrs": {
        "__name__": "lepton__aec2_node_infiniband_port_data_received_total__byte_per_s"
      },
      "values": [
        {
          "metric_time": "2024-04-09T10:05:00Z",
          "values": 5784.532
        },
        {
          "metric_time": "2024-04-09T10:10:00Z",
          "values": 5870.8257
        }
      ]
    },
    {
      "metrics_attrs": {
        "__name__": "lepton__aec2_node_infiniband_port_data_total__byte_per_s"
      },
      "values": [
        {
          "metric_time": "2024-04-09T10:05:00Z",
          "values": 11601.773
        },
        {
          "metric_time": "2024-04-09T10:10:00Z",
          "values": 11746.882
        }
      ]
    }
  ],
  "start": "1712632500",
  "end": "1712661000",
  "step": 300,
  "range_align": true
}