Queries metric details.

Request parameters

The following table lists only the request parameters specific to this API and some common parameters. For the complete list of common parameters, see Common parameters.

Field	Position	Type	Required	Description
Action	Query	String	Yes	The action to be performed. Value: Draw.
Version	Query	String	Yes	API version. Value: 2022-11-09.
Graph	Body	Query	Yes	For details, see Graph.
CurrentVaribaleValues	Body	Array[Varable]	Yes	Pass in an empty array.
StartTime	Body	Int64	Yes	Start time.
EndTime	Body	Int64	Yes	End time.
GranularityUnit	Body	String	Yes	Time interval.
Granularity	Body	Int64	Yes	Interval.

Graph

Parameters	Type	Required	Description
Id	String	Yes	An arbitrary value passed in from the frontend.
GraphType	String	Yes	Dashboard type. time_series: Time-series graph table: Table single_value: Value
Name	String	Yes	An arbitrary value passed in from the frontend.
TimeSeriesConf	TimeSeriesGraphConfig	No	It can be used when the dashboard type is time_series. For details, see TimeSeriesGraphConfig.
TableConf	TableGraphConfig	No	It can be used when the dashboard type is table. For details, see TableGraphConfig.
SingleValueConf	SingleValueGraphConfig	No	It can be used when the dashboard type is single_value. For details, see SingleValueGraphConfig.

TimeSeriesGraphConfig

Parameters	Type	Required	Description
SimpleQueries	Array[TimeSeriesQuery]	Yes	Simple query. For details, see TimeSeriesQuery.
FormulaQueries	Array[FormulaQuery]	Yes	Formula query. For details, see FormulaQuery.
Precision	Int32	Yes	Precision (number of decimal places).
Marker	Array[Marker]	Yes	Marker. You need to pass in an empty array.
ShowLegend	Boolean	Yes	Whether to show the legend.
Legend	Array[String]	Yes	Legend list.

TimeSeriesQuery

Name	type	Required	Description
Id	String	Yes	The query name defined at the frontend.
Ispromql	Boolean	Yes	Whether it is a PromQL metric.
Promql	String	No	PromQL query.
Metric	String	Yes	The metric name.
Unit	String	Yes	Unit.
Alphabet	String	Yes	Symbols used in composite metric formulas.
Alias	String	Yes	Alias.
MetricCategory	String	Yes	Metric type. host process container custom_metric
MetricSource	String	Yes	Metric type. prometheus influxdb
GroupByFields	Array[String]	Yes	Grouping. tip If the ArkClaw instance has custom tags, you can use these tags in GroupByFields for grouped querying.
Aggregator	String	Yes	Group aggregation function.
AddFunc	String	Yes	Post-processing function. diff per_second_rate per_minute_rate per_second per_minute
Filters	Array[FilterCondition]	Yes	Filter condition. For details, see FilterCondition. tip If the ArkClaw instance has custom tags, you can use these tags in Filters for filtering.
Hide	Boolean	Yes	Whether to hide.
CounterAs	String	No	Counter type. count rate

TableQuery

Name	Type	Required	Description
Id	String	Yes	The query name defined at the frontend.
Ispromql	Boolean	Yes	Whether it is a PromQL metric.
Promql	String	No	PromQL query.
Metric	String	Yes	The metric name.
Unit	String	Yes	Unit.
Alphabet	String	Yes	Symbols used in composite metric formulas.
Alias	String	Yes	Alias.
MetricCategory	String	Yes	Metric type. host process container custom_metric
MetricSource	String	Yes	Metric type. prometheus influxdb
GroupByFields	Array[String]	Yes	Grouping. tip If the ArkClaw instance has custom tags, you can use these tags in GroupByFields for grouped querying.
Aggregator	String	Yes	Group aggregation function.
AddFunc	String	Yes	Post-processing function. diff per_second_rate per_minute_rate per_second per_minute
Filters	Array[FilterCondition]	Yes	Filter condition. For details, see FilterCondition. tip If the ArkClaw instance has custom tags, you can use these tags in Filters for filtering.
Hide	Boolean	Yes	Whether to show.
CounterAs	String	No	Counter type. count rate
RollupTimeframeByAggregator	String	No	Time window aggregation method. AVG SUM LAST COUNT MAX MIN

SingleValueQuery

Name	Type	Required	Description
Id	String	Yes	The query name defined at the frontend.
Ispromql	Boolean	Yes	Whether it is a PromQL metric.
Promql	String	No	PromQL query.
Metric	String	Yes	The metric name.
Unit	String	Yes	Unit.
Alphabet	String	Yes	Symbols used in composite metric formulas.
Alias	String	Yes	Alias.
MetricCategory	String	Yes	Metric type. host process container custom_metric
MetricSource	String	Yes	Metric type. prometheus influxdb
GroupByFields	Array[String]	Yes	Grouping. tip If the ArkClaw instance has custom tags, you can use these tags in GroupByFields for grouped querying.
Aggregator	String	Yes	Group aggregation function.
AddFunc	String	Yes	Post-processing function. diff per_second_rate per_minute_rate per_second per_minute
Filters	Array[FilterCondition]	Yes	Filter condition. For details, see FilterCondition. tip If the ArkClaw instance has custom tags, you can use these tags in Filters for filtering.
Hide	Boolean	Yes	Whether to hide.
CounterAs	String	No	Counter type. count rate
RollupTimeframeByAggregator	String	Yes	Time window aggregation method. AVG SUM LAST COUNT MAX MIN

FormulaQuery

Field	Type	Required	Description
Formula	String	Yes	Composite metric calculation formula.
Alias	String	No	Displayed name.
Unit	String	No	Unit.
Alphabet	String	No	Symbols used for calculation formulas.

Response parameters

The Result parameter contains the following fields:

Field	type	Description
SingleValue	SingleValueData	Numeric value dashboard. For details, see SingleValueData.
Table	TableData	Table dashboard. For details, see TableData.
TimeSeries	Array[TimeSeriesData]	Time-series data dashboard. For details, see TimeSeriesData.

SingleValueData

Field	Type	Sample value	Description
Value	String	100	Numeric value.
Unit	String	s	Unit.

TableData

Field	Type	Description
Columns	Array[String]	Column name.
Units	Array[String]	Units that correspond to individual column names.
Rows	Array[Array[String]]	Numeric value.

TimeSeriesData

Field	Type	Description
QueryId	String	Request ID. It is consistent with the ID in the request.
Title	String	Title. It is consistent with the Alias field in the request.
Unit	String	Unit.
Legend	Legend	Legend.
Points	Array[SeriesPoint]	Time-series data points.
Tagkvs	Array[Tagkv]	Label.

Legend

Field	Type	Description
Max	Float	Maximum value.
Min	Float	Minimum value.
Avg	Float	Average value.
Current	Float	Current value.

SeriesPoint

Field	Type	Description
Timestamp	String	Data timestamp.
Value	String	The value of the data point at this timestamp.
EndTimestamp	String	End timestamp. It is used for handling multi-point merging.

TagKV

Field	Type	Description
Key	String	Marker.
Lable	String	Label.
Value	String	Marker value.

Sample request

Sample response

Application Performance Management Plus