GetEmonMonitorData_Elasticsearch_API调试-阿里云OpenAPI开发者门户

请求语法

POST /openapi/emon/projects/{ProjectId}/metrics/query HTTP/1.1

路径参数

字段名称	字段详情
ProjectIdstring	项目 ID，格式为`es-当前账号 ID`。示例值:es-185320276651****

请求参数

字段名称	字段详情
bodystring	指定指标监控参数。示例值:{ "start": 1522127381471, "queries": [ { "metric": "elasticbuild.elasticsearch.source.total_doc_count", "aggregator": "sum", "downsample": "avg", "tags": { "taskName": "et-testtsk", "userId":"123456" }, "granularity": "1m" } ], "limit": "", "end": 1522129151000 }

请求说明

RequestBody

参数名	类型	是否必填	示例值	描述
start	Long	是	1522127381471	指标监控开始的时间戳。单位：毫秒。
expression	String	否	a+b	指标数据查询表达式。
queries	List	是		指标查询条件。
└id	String	否	a	查询条件 queries 如果用到了表达式 expression，queries json 数组里会描述 expression 里参与运算的指标，id 就是每个指标在 expression 里的代数符号，真正的指标名称在 queries 数组的每个元素里。
└metric	String	是	elasticbuild.elasticsearch.source.total_doc_count	指标名称。
└aggregator	String	是	sum	指标按 tags 维度聚合方式。即对指标按给定的 tags group by，进行 sum、avg、max、min 等聚合运算。
└downsample	String	是	avg	指标按时间精度聚合方式。即对指标在[start,end]窗口内的时间线，在时间维度降精度，例如把 20s 精度聚合为 1min、10min、1hour 精度，根据时间窗口的大小会自动降精度。
└tags	Map	是	[env,dev]	指标查询标签。格式为[key,value]，key 要明确指定，value 支持通配符，使用通配符可返回满足条件的多序列数据。
└granularity	String	是	1m	指标查询的时间精度。范围为[start,end]。单位：毫秒。
limit	String	是	"100 "	限定返回结果集的大小。为空则不限制，返回所有查询数据。一般用于 tags 里 value 使用通配符，返回结果集非常大的情况。
end	String	是	1522129151000	指标监控结束的时间戳。单位：毫秒。

说明 └表示子参数。

示例如下。

{
    "start": 1522127381471, 
    "queries": [
    {
        "metric": "elasticbuild.elasticsearch.source.total_doc_count",
        "aggregator": "sum",
        "downsample": "avg", 
        "tags": {
          "taskName": "et-testtsk",
          "userId":"123456" 
        }, 
        "granularity": "1m" 
      }
    ], 
    "limit": "",  
    "end": 1522129151000
}

返回参数

字段名称	字段详情
Codestring	请求状态码。示例值:200
Messagestring	请求结果。示例值:""
RequestIdstring	请求 ID。示例值:2D184B55-FA51-43F7-A1EF-E68A0545****
Successboolean	请求是否成功：展开详情示例值:true
Resultarray<object>	返回结果。

返回说明

以下返回示例中，本文只保证包含返回数据列表中的参数，而未提到的参数仅供参考，程序中不能强制依赖获取这些参数。

变更历史

暂无变更历史