1. 接口描述
接口请求域名: cwp.tencentcloudapi.com 。
获取ES字段聚合结果
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeESAggregations。 |
Version | 是 | String | 公共参数,本接口取值:2018-02-28。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
Query | 是 | String | ES聚合条件JSON 示例值:{"cwp":"dev"} |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Data | String | ES聚合结果JSON 示例值: "{"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 | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取ES字段聚合结果
输入示例
https://cwp.tencentcloudapi.com/?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\"}}}}}}
&<公共请求参数>
输出示例
{
"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"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.APIServerFail | 调用API服务失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
MissingParameter | 缺少参数错误。 |