1. 接口描述
接口请求域名: cwp.tencentcloudapi.com 。
获取索引列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeIndexList。 |
Version | 是 | String | 公共参数,本接口取值:2018-02-28。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Data | String | ES 索引信息 示例值:xxx |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取索引列表
输入示例
https://cwp.tencentcloudapi.com/?Action=DescribeIndexList
&<公共请求参数>
输出示例
{
"Response": {
"Data": "{\"indexSort\":{\"资产管理\":[\"userlog-asset_component\"],\"入侵检测\":[\"userlog-malware\"],\"网络防御\":[\"userlog-network_attack\"]},\"indexArr\":[\"userlog-asset_component\",\"userlog-malware\",\"userlog-network_attack\"],\"fieldArr\":[{\"quuid\":{\"keyword\":{\"type\":\"keyword\",\"searchable\":true,\"aggregatable\":true}},\"_index\":{\"_index\":{\"type\":\"_index\",\"searchable\":true,\"aggregatable\":true}},\"_feature\":{\"_feature\":{\"type\":\"_feature\",\"searchable\":true,\"aggregatable\":false}},\"hostip\":{\"keyword\":{\"type\":\"keyword\",\"searchable\":true,\"aggregatable\":true}},\"user_name\":{\"keyword\":{\"type\":\"keyword\",\"searchable\":true,\"aggregatable\":true}},\"modify_time\":{\"date\":{\"type\":\"date\",\"searchable\":true,\"aggregatable\":true}},\"pid\":{\"long\":{\"type\":\"long\",\"searchable\":true,\"aggregatable\":true}},\"proc_tree\":{\"text\":{\"type\":\"text\",\"searchable\":true,\"aggregatable\":false}},\"uuid\":{\"keyword\":{\"type\":\"keyword\",\"searchable\":true,\"aggregatable\":true}},\"dst_ip\":{\"keyword\":{\"type\":\"keyword\",\"searchable\":true,\"aggregatable\":true}},\"parent_proc_path\":{\"text\":{\"type\":\"text\",\"searchable\":true,\"aggregatable\":false}},\"_ignored\":{\"_ignored\":{\"type\":\"_ignored\",\"searchable\":true,\"aggregatable\":false}},\"process_name\":{\"keyword\":{\"type\":\"keyword\",\"searchable\":true,\"aggregatable\":true}},\"id\":{\"long\":{\"type\":\"long\",\"searchable\":true,\"aggregatable\":true}},\"full_path\":{\"text\":{\"type\":\"text\",\"searchable\":true,\"aggregatable\":false}},\"_version\":{\"_version\":{\"type\":\"_version\",\"searchable\":false,\"aggregatable\":false}},\"_routing\":{\"_routing\":{\"type\":\"_routing\",\"searchable\":true,\"aggregatable\":false}},\"user_group\":{\"keyword\":{\"type\":\"keyword\",\"searchable\":true,\"aggregatable\":true}},\"create_time\":{\"date\":{\"type\":\"date\",\"searchable\":true,\"aggregatable\":true}},\"_type\":{\"_type\":{\"type\":\"_type\",\"searchable\":true,\"aggregatable\":true}},\"ppid\":{\"long\":{\"type\":\"long\",\"searchable\":true,\"aggregatable\":true}},\"find_time\":{\"date\":{\"type\":\"date\",\"searchable\":true,\"aggregatable\":true}},\"_seq_no\":{\"_seq_no\":{\"type\":\"_seq_no\",\"searchable\":true,\"aggregatable\":true}},\"parent_proc_group\":{\"keyword\":{\"type\":\"keyword\",\"searchable\":true,\"aggregatable\":true}},\"parent_proc_user\":{\"keyword\":{\"type\":\"keyword\",\"searchable\":true,\"aggregatable\":true}},\"cmd_line\":{\"text\":{\"type\":\"text\",\"searchable\":true,\"aggregatable\":false}},\"_field_names\":{\"_field_names\":{\"type\":\"_field_names\",\"searchable\":true,\"aggregatable\":false}},\"parent_proc_name\":{\"keyword\":{\"type\":\"keyword\",\"searchable\":true,\"aggregatable\":true}},\"appid\":{\"long\":{\"type\":\"long\",\"searchable\":true,\"aggregatable\":true}},\"dst_port\":{\"long\":{\"type\":\"long\",\"searchable\":true,\"aggregatable\":true}},\"_source\":{\"_source\":{\"type\":\"_source\",\"searchable\":false,\"aggregatable\":false}},\"_id\":{\"_id\":{\"type\":\"_id\",\"searchable\":true,\"aggregatable\":true}},\"status\":{\"long\":{\"type\":\"long\",\"searchable\":true,\"aggregatable\":true}}},{\"_index\":{\"_index\":{\"type\":\"_index\",\"searchable\":true,\"aggregatable\":true}},\"hostip\":{\"keyword\":{\"type\":\"keyword\",\"searchable\":true,\"aggregatable\":true}},\"_feature\":{\"_feature\":{\"type\":\"_feature\",\"searchable\":true,\"aggregatable\":false}},\"modify_time\":{\"date\":{\"type\":\"date\",\"searchable\":true,\"aggregatable\":true}},\"filemodifiertime\":{\"long\":{\"type\":\"long\",\"searchable\":true,\"aggregatable\":true}},\"filesize\":{\"keyword\":{\"type\":\"keyword\",\"searchable\":true,\"aggregatable\":true}},\"uuid\":{\"keyword\":{\"type\":\"keyword\",\"searchable\":true,\"aggregatable\":true}},\"_ignored\":{\"_ignored\":{\"type\":\"_ignored\",\"searchable\":true,\"aggregatable\":false}},\"virusname\":{\"keyword\":{\"type\":\"keyword\",\"searchable\":true,\"aggregatable\":true}},\"filepath\":{\"text\":{\"type\":\"text\",\"searchable\":true,\"aggregatable\":false}},\"id\":{\"long\":{\"type\":\"long\",\"searchable\":true,\"aggregatable\":true}},\"_version\":{\"_version\":{\"type\":\"_version\",\"searchable\":false,\"aggregatable\":false}},\"_routing\":{\"_routing\":{\"type\":\"_routing\",\"searchable\":true,\"aggregatable\":false}},\"create_time\":{\"date\":{\"type\":\"date\",\"searchable\":true,\"aggregatable\":true}},\"_type\":{\"_type\":{\"type\":\"_type\",\"searchable\":true,\"aggregatable\":true}},\"fileaccesstime\":{\"long\":{\"type\":\"long\",\"searchable\":true,\"aggregatable\":true}},\"pathmd5\":{\"keyword\":{\"type\":\"keyword\",\"searchable\":true,\"aggregatable\":true}},\"bwtype\":{\"long\":{\"type\":\"long\",\"searchable\":true,\"aggregatable\":true}},\"_seq_no\":{\"_seq_no\":{\"type\":\"_seq_no\",\"searchable\":true,\"aggregatable\":true}},\"_field_names\":{\"_field_names\":{\"type\":\"_field_names\",\"searchable\":true,\"aggregatable\":false}},\"filecreatetime\":{\"long\":{\"type\":\"long\",\"searchable\":true,\"aggregatable\":true}},\"appid\":{\"long\":{\"type\":\"long\",\"searchable\":true,\"aggregatable\":true}},\"_source\":{\"_source\":{\"type\":\"_source\",\"searchable\":false,\"aggregatable\":false}},\"_id\":{\"_id\":{\"type\":\"_id\",\"searchable\":true,\"aggregatable\":true}},\"status\":{\"long\":{\"type\":\"long\",\"searchable\":true,\"aggregatable\":true}},\"md5\":{\"keyword\":{\"type\":\"keyword\",\"searchable\":true,\"aggregatable\":true}}},{\"_routing\":{\"_routing\":{\"type\":\"_routing\",\"searchable\":true,\"aggregatable\":false}},\"component_id\":{\"long\":{\"type\":\"long\",\"searchable\":true,\"aggregatable\":true}},\"quuid\":{\"keyword\":{\"type\":\"keyword\",\"searchable\":true,\"aggregatable\":true}},\"_index\":{\"_index\":{\"type\":\"_index\",\"searchable\":true,\"aggregatable\":true}},\"create_time\":{\"date\":{\"type\":\"date\",\"searchable\":true,\"aggregatable\":true}},\"_feature\":{\"_feature\":{\"type\":\"_feature\",\"searchable\":true,\"aggregatable\":false}},\"hostip\":{\"keyword\":{\"type\":\"keyword\",\"searchable\":true,\"aggregatable\":true}},\"modify_time\":{\"date\":{\"type\":\"date\",\"searchable\":true,\"aggregatable\":true}},\"_type\":{\"_type\":{\"type\":\"_type\",\"searchable\":true,\"aggregatable\":true}},\"remark\":{\"text\":{\"type\":\"text\",\"searchable\":true,\"aggregatable\":false}},\"type\":{\"keyword\":{\"type\":\"keyword\",\"searchable\":true,\"aggregatable\":true}},\"uuid\":{\"keyword\":{\"type\":\"keyword\",\"searchable\":true,\"aggregatable\":true}},\"version\":{\"keyword\":{\"type\":\"keyword\",\"searchable\":true,\"aggregatable\":true}},\"_ignored\":{\"_ignored\":{\"type\":\"_ignored\",\"searchable\":true,\"aggregatable\":false}},\"_seq_no\":{\"_seq_no\":{\"type\":\"_seq_no\",\"searchable\":true,\"aggregatable\":true}},\"path\":{\"text\":{\"type\":\"text\",\"searchable\":true,\"aggregatable\":false}},\"_field_names\":{\"_field_names\":{\"type\":\"_field_names\",\"searchable\":true,\"aggregatable\":false}},\"appid\":{\"long\":{\"type\":\"long\",\"searchable\":true,\"aggregatable\":true}},\"_source\":{\"_source\":{\"type\":\"_source\",\"searchable\":false,\"aggregatable\":false}},\"_id\":{\"_id\":{\"type\":\"_id\",\"searchable\":true,\"aggregatable\":true}},\"id\":{\"long\":{\"type\":\"long\",\"searchable\":true,\"aggregatable\":true}},\"_version\":{\"_version\":{\"type\":\"_version\",\"searchable\":false,\"aggregatable\":false}}}]}",
"RequestId": "49082d4a-71b4-4e32-9ca1-b33872a4a63a"
}
}
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 | 内部错误。 |