获取ES字段聚合结果
最近更新时间: 2026-09-17 00:02:46
1. 接口描述
接口请求域名： cwp.api3.fincloud.tencent.cn。
获取ES字段聚合结果
默认接口请求频率限制：20次/秒。
接口更新时间：2022-05-20 15:12:33。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeESAggregations |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-02-28 |
| Region | 是 | 否 | String | 公共参数，地域信息本接口不需要传递此参数。 |
| Query | 是 | 否 | String | ES聚合条件JSON 示例值： {"cwp":"dev"} |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | String | ES聚合结果JSON 示例值： {"took":12,"total":3,"aggs":{"dst_port":{},"src_port":{}},"code":0,"message":"success"} |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| MissingParameter | 缺少参数错误。 |
| FailedOperation.APIServerFail | 调用API服务失败。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
5. 示例
示例1 获取ES字段聚合结果
输入示例
https://cwp.api3.fincloud.tencent.cn/?Action=DescribeESAggregations
&Query={\"index\":[\"netflow\"],\"body\":{\"query\":{\"bool\":{\"filter\":{\"bool\":{\"filter\":{\"range\":{\"timestamp\":{\"gte\":1597075200000,\"lte\":1597161599999}}},\"must\":[],\"must_not\":[],\"should\":[]}}}},\"aggs\":{\"src_port\":{\"terms\":{\"field\":\"src_port\",\"size\":500,\"order\":{\"_count\":\"desc\"}}},\"dst_port\":{\"terms\":{\"field\":\"dst_port\",\"size\":500,\"order\":{\"_count\":\"desc\"}}}}}}
&<Public request parameters>
输出示例
{
"Response": {
"Data": "{\"took\":114,\"total\":352317,\"aggs\":{\"dst_port\":{\"doc_count_error_upper_bound\":30,\"sum_other_doc_count\":116350,\"buckets\":[{\"key\":445,\"key_as_string\":null,\"KeyNumber\":0,\"doc_count\":53456},{\"key\":80,\"key_as_string\":null,\"KeyNumber\":0,\"doc_count\":33405},{\"key\":443,\"key_as_string\":null,\"KeyNumber\":0,\"doc_count\":17870}]},\"src_port\":{\"doc_count_error_upper_bound\":40,\"sum_other_doc_count\":233518,\"buckets\":[{\"key\":43957,\"key_as_string\":null,\"KeyNumber\":0,\"doc_count\":9878},{\"key\":40416,\"key_as_string\":null,\"KeyNumber\":0,\"doc_count\":4187},{\"key\":49892,\"key_as_string\":null,\"KeyNumber\":0,\"doc_count\":4100}]}},\"code\":0,\"message\":\"success\"}",
"RequestId": "e4ee7f6c-a036-43e7-b98f-96f174827fea"
}
}