获取指标列表
功能介绍
获取指标列表
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/workspaces/{workspace_id}/soc/metrics
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取项目ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
workspace_id |
是 |
String |
参数解释: 工作空间id。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。获取用户Token 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
content-type |
是 |
String |
参数解释: 内容类型
约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
X-request-id |
String |
请求ID,格式为:request_uuid-timestamp-hostname |
参数 |
参数类型 |
描述 |
---|---|---|
[数组元素] |
Array of ShowMetricMetaDataResponseBody objects |
查询指标列表结果 |
参数 |
参数类型 |
描述 |
---|---|---|
metric_name |
String |
指标名称 |
metric_type |
String |
指标类型 衍生指标DERIVED(单个CBSL或API查询可获取的,包括限定条件)、复合指标COMPOUND(需多个原子指标运算获取的) |
data_type |
String |
数据类型, TRACK:埋点指标,STATISTICS:统计指标,LOGISTIC:逻辑指标 |
metric_dimension |
Integer |
指标结果维度,0维:单个数字,2维:图表或表格,3+维:多标签图表, metric_type为DERIVED必填,为COMPOUND选填(COMPOUND时必为0) |
cache_ttl |
Long |
缓存生命周期,单位s |
report_period |
Long |
上报周期,埋点指标时必填,单位s |
is_built_in |
Boolean |
是否为系统指标 |
effective_column |
String |
生效的列, 当有该参数时,使用指定列作为指标数据结果 |
max_query_range |
Integer |
指标支持的最大检索范围,单位:天;复合指标时,数值为derived_metrics列表元素中最小值 |
derived_metrics |
Array of derived_metrics objects |
衍生指标列表,非复合指标时只有一个元素,复合指标时,为各衍生指标的定义 |
compound_expression |
String |
metric_type为DERIVED时填写, 复合指标的表达式 |
metric_format |
Array of MetricFormat objects |
指标格式 |
metric_expand_dim |
MetricDimensionExpandParam object |
指标维度扩充参数 |
version |
String |
安全云脑版本 |
metric_id |
String |
指标Id |
参数 |
参数类型 |
描述 |
---|---|---|
metric_dimension |
Integer |
衍生指标结果维度,0维:单个数字,2维:图表或表格,3+维:多标签图表 |
max_query_range |
Integer |
指标支持的最大检索范围,单位:天; |
date_start |
String |
指标查询范围相对起始时间 datemath表达式 |
date_end |
String |
指标查询范围相对截止时间 datemath表达式 |
date_format |
String |
时间格式,epoch_millis;epoch_second;yyyy-MM-dd'T'HH:mm:ss.SSSZ |
query_type |
String |
获取指标结果方式,cbsl, api, dsl, sql |
query_function |
String |
获取指标结果的方法,转义成字符串, 共四种query方式:CBSL、API、DSL、SQL
|
参数 |
参数类型 |
描述 |
---|---|---|
data |
String |
数据格式 |
display |
String |
显示格式 |
display_param |
Map<String,String> |
显示参数 |
data_param |
Map<String,String> |
数据参数 |
参数 |
参数类型 |
描述 |
---|---|---|
labels |
Array of strings |
维度扩充标签 |
functions |
Array of strings |
维度扩充方法,填写指标数据面内置方法, 参数index从1开始 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
X-request-id |
String |
请求ID,格式为:request_uuid-timestamp-hostname |
参数 |
参数类型 |
描述 |
---|---|---|
code |
String |
参数解释: 错误码 取值范围: 不涉及 |
message |
String |
参数解释: 错误描述 取值范围: 不涉及 |
请求示例
无
响应示例
无
状态码
状态码 |
描述 |
---|---|
200 |
指标列表 |
400 |
错误响应 |
错误码
请参见错误码。