导出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 公共参数,本接口取值:DescribeSearchExportList
Version String 公共参数,本接口取值:2018-02-28
Region String 公共参数,地域信息本接口不需要传递此参数。
Query String ES查询条件JSON
示例值: {"event_type":"vul"}

3. 输出参数

参数名称 类型 描述
DownloadUrl String 该参数作废
示例值: http://domain.com/anypath/x
TaskId Uint64 任务ID,需要到接口“异步导出任务”ExportTasks获取DownloadUrl下载地址
示例值: 1
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码

错误码 描述
InternalError 内部错误。
MissingParameter 缺少参数错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。

5. 示例

示例1 导出ES查询文档列表

导出ES查询文档列表

输入示例

https://cwp.api3.fincloud.tencent.cn/?Action=DescribeSearchExportList
&Query={\"index\":[\"netflow\"],\"body\":{\"query\":{\"bool\":{\"filter\":{\"bool\":{\"filter\":{\"range\":{\"timestamp\":{\"gte\":1597075200000,\"lte\":1597161599999}}},\"must\":[],\"must_not\":[],\"should\":[]}}}},\"highlight\":{\"fields\":{\"*\":{}}}},\"sort\":[{\"timestamp\":\"desc\"}]}
&<Public request parameters>

输出示例

{
    "Response": {
        "DownloadUrl":"http://www.a.b.c",
                "TaskId":10000,
        "RequestId": "e4ee7f6c-a036-43e7-b98f-96f174827fea"
    }
}