批量查询指标结果
功能介绍
批量查询指标结果
调用方法
请参见如何调用API。
URI
POST /v1/{project_id}/workspaces/{workspace_id}/sa/metrics/hits
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID |
|
workspace_id |
是 |
String |
工作空间ID |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
timespan |
否 |
String |
查询指标的时间范围，ISO8601格式，例如：2007-03-01T13:00:00Z/2008-05-11T15:30:00Z或2007-03-01T13:00:00Z/P1Y2M10DT2H30M或P1Y2M10DT2H30M/2008-05-11T15:30:00Z |
|
cache |
否 |
Boolean |
是否启用缓存，默认true, 禁用缓存 false |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
metric_ids |
是 |
Array of strings |
待查询的指标Id列表, 可参照附录中指标信息说明获取已有指标信息。 |
|
workspace_ids |
否 |
Array of strings |
工作空间列表, 当指标支持获取多工作空间数据时填写。 |
|
params |
否 |
Array of Map<String,String> objects |
待查询指标的参数列表，列表内每个元素为<String, String>的K-V形式，元素数量必须与metric_ids列表相同，具体填写方式请参照附录。 |
|
interactive_params |
否 |
Array of Map<String,String> objects |
交互式参数查询，当指标支持交互式参数时，填写<String, String>的K-V形式的参数列表，具体填写方式请参照附录。 |
|
field_ids |
否 |
Array of strings |
指标卡片ID列表 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
[数组元素] |
Array of ShowMetricResultResponseBody objects |
批量查询指标结果 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
metric_id |
String |
指标ID |
|
result |
result object |
指标查询结果内容 |
|
metric_format |
Array of MetricFormat objects |
指标显示格式，根据不同指标固定返回。 |
|
log_msg |
String |
结果日志信息 |
|
status |
String |
查询结果状态，SUCCESS：查询成功，FAILED：查询失败，FALLBACK：使用默认值 |
请求示例
通过指标接口查询从6月25日至当前的告警等级分布
https://{endpoint}/v1/{project_id}/workspaces/{workspace_id}/sa/metrics/hits
{
"metric_ids" : [ "1f0f5e29-5a92-17a5-2c16-5f37c6dc109c" ],
"params" : [ {
"start_date" : "2024-06-25T00:00:00.000+08:00"
} ]
}
响应示例
状态码：200
请求成功
[ {
"metric_id" : "1f0f5e29-5a92-17a5-2c16-5f37c6dc109c",
"result" : {
"labels" : [ "label1" ],
"datarows" : [ [ { } ] ],
"effective_column" : "0:1"
},
"status" : "SUCCESS"
} ]
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求成功 |
错误码
请参见错误码。
